@fluentcommerce/fc-connect-sdk 0.1.54 → 0.1.56

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 (476) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +11 -0
  3. package/dist/cjs/clients/fluent-client.js +13 -6
  4. package/dist/cjs/utils/pagination-helpers.js +38 -2
  5. package/dist/cjs/versori/fluent-versori-client.js +11 -5
  6. package/dist/esm/clients/fluent-client.js +13 -6
  7. package/dist/esm/utils/pagination-helpers.js +38 -2
  8. package/dist/esm/versori/fluent-versori-client.js +11 -5
  9. package/dist/tsconfig.esm.tsbuildinfo +1 -1
  10. package/dist/tsconfig.tsbuildinfo +1 -1
  11. package/dist/tsconfig.types.tsbuildinfo +1 -1
  12. package/docs/00-START-HERE/EXPORT-VALIDATION.md +158 -158
  13. package/docs/00-START-HERE/cli-analyze-source-structure-guide.md +655 -655
  14. package/docs/00-START-HERE/cli-documentation-index.md +202 -202
  15. package/docs/00-START-HERE/cli-quick-reference.md +252 -252
  16. package/docs/00-START-HERE/decision-tree.md +552 -552
  17. package/docs/00-START-HERE/getting-started.md +1070 -1070
  18. package/docs/00-START-HERE/mapper-quick-decision-guide.md +235 -235
  19. package/docs/00-START-HERE/readme.md +237 -237
  20. package/docs/00-START-HERE/retailerid-configuration.md +404 -404
  21. package/docs/00-START-HERE/sdk-philosophy.md +794 -794
  22. package/docs/00-START-HERE/troubleshooting-quick-reference.md +1086 -1086
  23. package/docs/01-TEMPLATES/faq.md +686 -686
  24. package/docs/01-TEMPLATES/patterns/pattern-templates-guide.md +68 -68
  25. package/docs/01-TEMPLATES/patterns/patterns-csv-schema-validation-and-rejection-report.md +233 -233
  26. package/docs/01-TEMPLATES/patterns/patterns-custom-resolvers.md +407 -407
  27. package/docs/01-TEMPLATES/patterns/patterns-error-handling-retry.md +511 -511
  28. package/docs/01-TEMPLATES/patterns/patterns-field-mapping-universal.md +701 -701
  29. package/docs/01-TEMPLATES/patterns/patterns-large-file-splitting.md +1430 -1430
  30. package/docs/01-TEMPLATES/patterns/patterns-master-data-etl.md +2399 -2399
  31. package/docs/01-TEMPLATES/patterns/patterns-pagination-streaming.md +447 -447
  32. package/docs/01-TEMPLATES/patterns/patterns-state-duplicate-prevention.md +385 -385
  33. package/docs/01-TEMPLATES/readme.md +957 -957
  34. package/docs/01-TEMPLATES/standalone/standalone-asn-inbound-processing.md +1209 -1209
  35. package/docs/01-TEMPLATES/standalone/standalone-graphql-query-export.md +1140 -1140
  36. package/docs/01-TEMPLATES/standalone/standalone-graphql-to-parquet-partitioned-s3.md +432 -432
  37. package/docs/01-TEMPLATES/standalone/standalone-multi-channel-inventory-sync.md +1185 -1185
  38. package/docs/01-TEMPLATES/standalone/standalone-multi-source-aggregation.md +1462 -1462
  39. package/docs/01-TEMPLATES/standalone/standalone-s3-csv-batch-api.md +1390 -1390
  40. package/docs/01-TEMPLATES/standalone/standalone-s3-csv-inventory-to-batch.md +330 -330
  41. package/docs/01-TEMPLATES/standalone/standalone-scripts-guide.md +87 -87
  42. package/docs/01-TEMPLATES/standalone/standalone-sftp-xml-graphql.md +1444 -1444
  43. package/docs/01-TEMPLATES/standalone/standalone-webhook-payload-processing.md +688 -688
  44. package/docs/01-TEMPLATES/versori/business-examples/business-examples-dropship-order-routing.md +193 -193
  45. package/docs/01-TEMPLATES/versori/business-examples/business-examples-graphql-parquet-extraction.md +518 -518
  46. package/docs/01-TEMPLATES/versori/business-examples/business-examples-inter-location-transfers.md +2162 -2162
  47. package/docs/01-TEMPLATES/versori/business-examples/business-examples-pre-order-allocation.md +2226 -2226
  48. package/docs/01-TEMPLATES/versori/business-examples/business-scenarios-guide.md +87 -87
  49. package/docs/01-TEMPLATES/versori/patterns/versori-patterns-connection-validation-pattern.md +656 -656
  50. package/docs/01-TEMPLATES/versori/patterns/versori-patterns-dual-workflow-connector.md +835 -835
  51. package/docs/01-TEMPLATES/versori/patterns/versori-patterns-guide.md +108 -108
  52. package/docs/01-TEMPLATES/versori/patterns/versori-patterns-kv-state-management.md +1533 -1533
  53. package/docs/01-TEMPLATES/versori/patterns/versori-patterns-xml-response-patterns.md +1160 -1160
  54. package/docs/01-TEMPLATES/versori/versori-platform-guide.md +201 -201
  55. package/docs/01-TEMPLATES/versori/webhooks/template-webhook-asn-purchase-order.md +1906 -1906
  56. package/docs/01-TEMPLATES/versori/webhooks/template-webhook-dropship-routing.md +1074 -1074
  57. package/docs/01-TEMPLATES/versori/webhooks/template-webhook-flash-sale-reserve.md +1395 -1395
  58. package/docs/01-TEMPLATES/versori/webhooks/template-webhook-generic-xml-order.md +888 -888
  59. package/docs/01-TEMPLATES/versori/webhooks/template-webhook-payment-gateway-integration.md +2478 -2478
  60. package/docs/01-TEMPLATES/versori/webhooks/template-webhook-rma-returns-comprehensive.md +2240 -2240
  61. package/docs/01-TEMPLATES/versori/webhooks/template-webhook-xml-order-ingestion.md +2029 -2029
  62. package/docs/01-TEMPLATES/versori/webhooks/webhook-templates-guide.md +140 -140
  63. package/docs/01-TEMPLATES/versori/workflows/_examples/sample-data/inventory-mapping.json +20 -20
  64. package/docs/01-TEMPLATES/versori/workflows/_examples/sample-data/products_2025-01-22.csv +11 -11
  65. package/docs/01-TEMPLATES/versori/workflows/_examples/sample-data/sample-data-guide.md +34 -34
  66. package/docs/01-TEMPLATES/versori/workflows/_examples/workflow-examples-guide.md +36 -36
  67. package/docs/01-TEMPLATES/versori/workflows/extraction/extraction-modes-guide.md +1038 -1038
  68. package/docs/01-TEMPLATES/versori/workflows/extraction/extraction-workflows-guide.md +138 -138
  69. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/graphql-extraction-guide.md +63 -63
  70. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-fulfillments-to-sftp-csv.md +2062 -2062
  71. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-fulfillments-to-sftp-xml.md +2294 -2294
  72. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-inventory-positions-to-s3-csv.md +2461 -2461
  73. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-inventory-positions-to-sftp-xml.md +2529 -2529
  74. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-inventory-quantities-to-s3-csv.md +2464 -2464
  75. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-inventory-quantities-to-s3-json.md +1959 -1959
  76. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-orders-to-s3-csv.md +1953 -1953
  77. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-orders-to-sftp-xml.md +2541 -2541
  78. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-products-to-s3-json.md +2384 -2384
  79. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-products-to-sftp-xml.md +2445 -2445
  80. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-virtual-positions-to-s3-csv.md +2355 -2355
  81. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-virtual-positions-to-s3-json.md +2042 -2042
  82. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-virtual-positions-to-sftp-xml.md +2726 -2726
  83. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/batch-api-guide.md +206 -206
  84. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-cycle-count-reconciliation.md +2030 -2030
  85. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-multi-channel-inventory-sync.md +1882 -1882
  86. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-s3-csv-inventory-batch.md +2827 -2827
  87. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-s3-json-inventory-batch.md +1952 -1952
  88. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-s3-xml-inventory-batch.md +3289 -3289
  89. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-sftp-csv-inventory-batch.md +3064 -3064
  90. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-sftp-json-inventory-batch.md +3238 -3238
  91. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-sftp-xml-inventory-batch.md +2977 -2977
  92. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/event-api-guide.md +321 -321
  93. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-payload-json-order-cancel-event.md +959 -959
  94. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-payload-xml-order-cancel-event.md +1170 -1170
  95. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-s3-csv-product-event.md +2312 -2312
  96. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-s3-json-product-event.md +2999 -2999
  97. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-s3-parquet-product-event.md +2836 -2836
  98. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-s3-xml-product-event.md +2395 -2395
  99. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-sftp-csv-product-event.md +2295 -2295
  100. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-sftp-json-product-event.md +2602 -2602
  101. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-sftp-parquet-product-event.md +2589 -2589
  102. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-sftp-xml-product-event.md +3578 -3578
  103. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/graphql-mutations-guide.md +93 -93
  104. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-payload-json-order-update-graphql.md +1260 -1260
  105. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-payload-xml-order-update-graphql.md +1472 -1472
  106. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-csv-control-graphql.md +2417 -2417
  107. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-csv-location-graphql.md +2811 -2811
  108. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-csv-price-graphql.md +2619 -2619
  109. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-json-location-graphql.md +2807 -2807
  110. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-xml-location-graphql.md +2373 -2373
  111. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-sftp-csv-control-graphql.md +2740 -2740
  112. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-sftp-csv-location-graphql.md +2760 -2760
  113. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-sftp-json-location-graphql.md +1710 -1710
  114. package/docs/01-TEMPLATES/versori/workflows/ingestion/ingestion-workflows-guide.md +136 -136
  115. package/docs/01-TEMPLATES/versori/workflows/rubix-webhooks/rubix-webhooks-guide.md +520 -520
  116. package/docs/01-TEMPLATES/versori/workflows/rubix-webhooks/template-webhook-rubix-fulfilment-to-sftp-xml-inline.md +1418 -1418
  117. package/docs/01-TEMPLATES/versori/workflows/rubix-webhooks/template-webhook-rubix-fulfilment-to-sftp-xml-universal-mapper.md +1785 -1785
  118. package/docs/01-TEMPLATES/versori/workflows/rubix-webhooks/template-webhook-rubix-order-attribute-update.md +824 -824
  119. package/docs/01-TEMPLATES/versori/workflows/workflows-overview-guide.md +646 -646
  120. package/docs/02-CORE-GUIDES/advanced-services/advanced-services-batch-archival.md +724 -724
  121. package/docs/02-CORE-GUIDES/advanced-services/advanced-services-job-tracker.md +627 -627
  122. package/docs/02-CORE-GUIDES/advanced-services/advanced-services-partial-batch-recovery.md +561 -561
  123. package/docs/02-CORE-GUIDES/advanced-services/advanced-services-quick-reference.md +367 -367
  124. package/docs/02-CORE-GUIDES/advanced-services/advanced-services-readme.md +407 -407
  125. package/docs/02-CORE-GUIDES/advanced-services/readme.md +49 -49
  126. package/docs/02-CORE-GUIDES/api-reference/api-reference-quick-reference.md +548 -548
  127. package/docs/02-CORE-GUIDES/api-reference/event-api-input-output-reference.md +702 -1171
  128. package/docs/02-CORE-GUIDES/api-reference/examples/client-initialization.ts +286 -286
  129. package/docs/02-CORE-GUIDES/api-reference/graphql-error-classification.md +337 -337
  130. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-01-client-api.md +399 -520
  131. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-03-authentication.md +199 -199
  132. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-04-graphql-mapping.md +925 -925
  133. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-05-services.md +1198 -1198
  134. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-06-data-sources.md +1083 -1083
  135. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-07-parsers.md +1097 -1097
  136. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-08-pagination.md +513 -513
  137. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-08-types.md +545 -597
  138. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-09-error-handling.md +527 -527
  139. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-09-webhook-validation.md +514 -514
  140. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-10-extraction.md +557 -557
  141. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-10-utilities.md +412 -412
  142. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-11-cli-tools.md +423 -423
  143. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-11-error-handling.md +716 -716
  144. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-12-analyze-source-structure.md +518 -518
  145. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-12-partial-responses.md +212 -212
  146. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-12-testing.md +300 -300
  147. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-13-resolver-builder.md +322 -322
  148. package/docs/02-CORE-GUIDES/api-reference/readme.md +279 -279
  149. package/docs/02-CORE-GUIDES/auto-pagination/auto-pagination-quick-reference.md +351 -351
  150. package/docs/02-CORE-GUIDES/auto-pagination/auto-pagination-readme.md +277 -277
  151. package/docs/02-CORE-GUIDES/auto-pagination/examples/auto-pagination-readme.md +178 -178
  152. package/docs/02-CORE-GUIDES/auto-pagination/examples/common-patterns.ts +351 -351
  153. package/docs/02-CORE-GUIDES/auto-pagination/examples/paginate-products.ts +384 -384
  154. package/docs/02-CORE-GUIDES/auto-pagination/examples/paginate-virtual-positions.ts +308 -308
  155. package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-01-foundations.md +470 -470
  156. package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-02-quick-start.md +713 -713
  157. package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-03-configuration.md +754 -754
  158. package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-04-advanced-patterns.md +732 -732
  159. package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-05-sdk-integration.md +847 -847
  160. package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-06-troubleshooting.md +359 -359
  161. package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-07-api-reference.md +462 -462
  162. package/docs/02-CORE-GUIDES/auto-pagination/readme.md +54 -54
  163. package/docs/02-CORE-GUIDES/data-sources/data-sources-file-operations-error-handling.md +1487 -1487
  164. package/docs/02-CORE-GUIDES/data-sources/data-sources-quick-reference.md +836 -836
  165. package/docs/02-CORE-GUIDES/data-sources/data-sources-readme.md +276 -276
  166. package/docs/02-CORE-GUIDES/data-sources/data-sources-sftp-credential-access-security.md +553 -553
  167. package/docs/02-CORE-GUIDES/data-sources/examples/common-patterns.ts +409 -409
  168. package/docs/02-CORE-GUIDES/data-sources/examples/data-sources-readme.md +178 -178
  169. package/docs/02-CORE-GUIDES/data-sources/examples/s3-operations.ts +308 -308
  170. package/docs/02-CORE-GUIDES/data-sources/examples/sftp-operations.ts +371 -371
  171. package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-01-foundations.md +735 -735
  172. package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-02-s3-operations.md +1302 -1302
  173. package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-03-sftp-operations.md +1379 -1379
  174. package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-04-file-patterns.md +941 -941
  175. package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-05-advanced-topics.md +813 -813
  176. package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-06-integration-patterns.md +486 -486
  177. package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-07-troubleshooting.md +387 -387
  178. package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-08-api-reference.md +417 -417
  179. package/docs/02-CORE-GUIDES/data-sources/readme.md +77 -77
  180. package/docs/02-CORE-GUIDES/error-handling-guide.md +936 -936
  181. package/docs/02-CORE-GUIDES/extraction/examples/02-core-guides-extraction-readme.md +116 -116
  182. package/docs/02-CORE-GUIDES/extraction/examples/common-patterns.ts +428 -428
  183. package/docs/02-CORE-GUIDES/extraction/examples/extract-inventory-basic.ts +187 -187
  184. package/docs/02-CORE-GUIDES/extraction/extraction-quick-reference.md +596 -596
  185. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-01-foundations.md +514 -514
  186. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-02-basic-extraction.md +823 -823
  187. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-03-parquet-processing.md +507 -507
  188. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-04-data-enrichment.md +546 -546
  189. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-05-transformation.md +494 -494
  190. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-06-export-formats.md +458 -458
  191. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-06-performance.md +138 -138
  192. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-07-api-reference.md +148 -148
  193. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-07-optimization.md +692 -692
  194. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-08-extraction-orchestrator.md +1008 -1008
  195. package/docs/02-CORE-GUIDES/extraction/readme.md +151 -151
  196. package/docs/02-CORE-GUIDES/ingestion/examples/_simple-kv-store.ts +40 -40
  197. package/docs/02-CORE-GUIDES/ingestion/examples/error-recovery.ts +728 -728
  198. package/docs/02-CORE-GUIDES/ingestion/examples/event-driven.ts +501 -501
  199. package/docs/02-CORE-GUIDES/ingestion/examples/local-file-ingestion.ts +88 -88
  200. package/docs/02-CORE-GUIDES/ingestion/examples/parquet-ingestion.ts +117 -117
  201. package/docs/02-CORE-GUIDES/ingestion/examples/performance-optimized.ts +647 -647
  202. package/docs/02-CORE-GUIDES/ingestion/examples/s3-csv-ingestion.ts +169 -169
  203. package/docs/02-CORE-GUIDES/ingestion/examples/sftp-csv-ingestion.ts +134 -134
  204. package/docs/02-CORE-GUIDES/ingestion/ingestion-quick-reference.md +546 -546
  205. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-01-introduction.md +626 -626
  206. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-02-quick-start.md +658 -658
  207. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-03-data-sources.md +1052 -1052
  208. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-04-field-mapping.md +763 -763
  209. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-05-advanced-parsers.md +676 -676
  210. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-06-batch-api.md +1295 -1295
  211. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-07-api-reference.md +138 -138
  212. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-07-state-management.md +1037 -1037
  213. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-08-performance-optimization.md +1349 -1349
  214. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-09-best-practices.md +1893 -1893
  215. package/docs/02-CORE-GUIDES/ingestion/readme.md +160 -160
  216. package/docs/02-CORE-GUIDES/logging-guide.md +585 -585
  217. package/docs/02-CORE-GUIDES/mapping/error-handling-patterns.md +401 -401
  218. package/docs/02-CORE-GUIDES/mapping/examples/02-core-guides-mapping-readme.md +128 -128
  219. package/docs/02-CORE-GUIDES/mapping/examples/common-patterns.ts +273 -273
  220. package/docs/02-CORE-GUIDES/mapping/examples/csv-location-ingestion.json +36 -36
  221. package/docs/02-CORE-GUIDES/mapping/examples/csv-mapping.ts +242 -242
  222. package/docs/02-CORE-GUIDES/mapping/examples/graphql-to-parquet-extraction.json +36 -36
  223. package/docs/02-CORE-GUIDES/mapping/examples/json-mapping.ts +213 -213
  224. package/docs/02-CORE-GUIDES/mapping/examples/json-product-to-mutation.json +48 -48
  225. package/docs/02-CORE-GUIDES/mapping/examples/xml-mapping.ts +291 -291
  226. package/docs/02-CORE-GUIDES/mapping/examples/xml-order-to-mutation.json +45 -45
  227. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/graphql-mutation-mapping-quick-reference.md +463 -463
  228. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/graphql-mutation-mapping-readme.md +227 -227
  229. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-01-introduction.md +222 -222
  230. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-02-quick-start.md +351 -351
  231. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-03-schema-validation.md +569 -569
  232. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-04-mapping-patterns.md +471 -471
  233. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-05-configuration-reference.md +611 -611
  234. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-06-advanced-xpath.md +148 -148
  235. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-06-path-syntax.md +464 -464
  236. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-07-api-reference.md +94 -94
  237. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-07-array-handling.md +307 -307
  238. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-08-custom-resolvers.md +544 -544
  239. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-09-advanced-patterns.md +427 -427
  240. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-10-hooks-and-variables.md +336 -336
  241. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-11-error-handling.md +488 -488
  242. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-12-arguments-vs-nodes.md +383 -383
  243. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-13-best-practices.md +477 -477
  244. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/readme.md +62 -62
  245. package/docs/02-CORE-GUIDES/mapping/mapping-format-decision-tree.md +480 -480
  246. package/docs/02-CORE-GUIDES/mapping/mapping-graphql-alias-batching-guide.md +820 -820
  247. package/docs/02-CORE-GUIDES/mapping/mapping-javascript-objects.md +2369 -2369
  248. package/docs/02-CORE-GUIDES/mapping/mapping-mapper-comparison-guide.md +682 -682
  249. package/docs/02-CORE-GUIDES/mapping/modules/02-core-guides-mapping-07-api-reference.md +1327 -1327
  250. package/docs/02-CORE-GUIDES/mapping/modules/02-core-guides-mapping-08-error-handling.md +1142 -1142
  251. package/docs/02-CORE-GUIDES/mapping/modules/mapping-04-use-cases.md +891 -891
  252. package/docs/02-CORE-GUIDES/mapping/modules/mapping-06-helpers-resolvers.md +1126 -1126
  253. package/docs/02-CORE-GUIDES/mapping/modules/mapping-06-sdk-resolvers.md +199 -199
  254. package/docs/02-CORE-GUIDES/mapping/modules/mapping-07-api-reference.md +1319 -1319
  255. package/docs/02-CORE-GUIDES/mapping/readme.md +178 -178
  256. package/docs/02-CORE-GUIDES/mapping/resolver-registration.md +410 -410
  257. package/docs/02-CORE-GUIDES/mapping/resolvers/examples/common-patterns.ts +226 -226
  258. package/docs/02-CORE-GUIDES/mapping/resolvers/examples/custom-resolvers.ts +227 -227
  259. package/docs/02-CORE-GUIDES/mapping/resolvers/examples/sdk-resolvers-usage.ts +203 -203
  260. package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-readme.md +274 -274
  261. package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-api-reference.md +679 -679
  262. package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-cookbook.md +826 -826
  263. package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-guide.md +1330 -1330
  264. package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-helpers-reference.md +1437 -1437
  265. package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-parameters-reference.md +553 -553
  266. package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-troubleshooting.md +854 -854
  267. package/docs/02-CORE-GUIDES/mapping/resolvers/readme.md +75 -75
  268. package/docs/02-CORE-GUIDES/parsers/examples/02-core-guides-parsers-readme.md +161 -161
  269. package/docs/02-CORE-GUIDES/parsers/examples/csv-parser-examples.ts +110 -110
  270. package/docs/02-CORE-GUIDES/parsers/examples/json-parser-examples.ts +33 -33
  271. package/docs/02-CORE-GUIDES/parsers/examples/parquet-parser-examples.ts +47 -47
  272. package/docs/02-CORE-GUIDES/parsers/examples/xml-parser-examples.ts +38 -38
  273. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-01-foundations.md +355 -355
  274. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-02-csv-parser.md +772 -772
  275. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-03-json-parser.md +789 -789
  276. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-04-xml-parser.md +857 -857
  277. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-05-parquet-parser.md +603 -603
  278. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-06-integration-patterns.md +702 -702
  279. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-06-streaming.md +121 -121
  280. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-07-api-reference.md +89 -89
  281. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-07-troubleshooting.md +727 -727
  282. package/docs/02-CORE-GUIDES/parsers/parsers-quick-reference.md +482 -482
  283. package/docs/02-CORE-GUIDES/parsers/parsers-readme.md +258 -258
  284. package/docs/02-CORE-GUIDES/parsers/readme.md +65 -65
  285. package/docs/02-CORE-GUIDES/readme.md +194 -194
  286. package/docs/02-CORE-GUIDES/webhook-validation/examples/basic-validation.ts +108 -108
  287. package/docs/02-CORE-GUIDES/webhook-validation/examples/common-patterns.ts +316 -316
  288. package/docs/02-CORE-GUIDES/webhook-validation/examples/webhook-validation-readme.md +61 -61
  289. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-01-foundations.md +440 -440
  290. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-02-quick-start.md +525 -525
  291. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-03-versori-integration.md +741 -741
  292. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-04-platform-integration.md +629 -629
  293. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-05-configuration.md +535 -535
  294. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-06-error-handling.md +611 -611
  295. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-06-troubleshooting.md +124 -124
  296. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-07-api-reference.md +511 -511
  297. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-08-rubix-webhooks.md +590 -590
  298. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-09-rubix-event-vs-http-call.md +432 -432
  299. package/docs/02-CORE-GUIDES/webhook-validation/readme.md +239 -239
  300. package/docs/02-CORE-GUIDES/webhook-validation/webhook-validation-quick-reference.md +392 -392
  301. package/docs/03-PATTERN-GUIDES/connector-scenarios/connector-scenarios-quick-reference.md +498 -498
  302. package/docs/03-PATTERN-GUIDES/connector-scenarios/connector-scenarios-readme.md +313 -313
  303. package/docs/03-PATTERN-GUIDES/connector-scenarios/examples/common-patterns.ts +612 -612
  304. package/docs/03-PATTERN-GUIDES/connector-scenarios/examples/connector-scenarios-readme.md +253 -253
  305. package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-01-foundations.md +452 -452
  306. package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-02-simple-scenarios.md +681 -681
  307. package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-03-intermediate-scenarios.md +637 -637
  308. package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-04-advanced-scenarios.md +650 -650
  309. package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-05-bidirectional-sync.md +233 -233
  310. package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-06-production-patterns.md +442 -442
  311. package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-07-reference.md +445 -445
  312. package/docs/03-PATTERN-GUIDES/connector-scenarios/readme.md +31 -31
  313. package/docs/03-PATTERN-GUIDES/enterprise-integration-patterns.md +1528 -1528
  314. package/docs/03-PATTERN-GUIDES/error-handling/comprehensive-error-handling-guide.md +1437 -1437
  315. package/docs/03-PATTERN-GUIDES/error-handling/error-handling-quick-reference.md +390 -390
  316. package/docs/03-PATTERN-GUIDES/error-handling/examples/common-patterns.ts +438 -438
  317. package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-01-foundations.md +362 -362
  318. package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-02-error-types.md +850 -850
  319. package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-03-utf8-handling.md +456 -456
  320. package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-04-error-scenarios.md +658 -658
  321. package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-05-calling-patterns.md +671 -671
  322. package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-06-retry-strategies.md +1034 -1034
  323. package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-07-monitoring.md +653 -653
  324. package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-08-api-reference.md +847 -847
  325. package/docs/03-PATTERN-GUIDES/error-handling/readme.md +36 -36
  326. package/docs/03-PATTERN-GUIDES/examples/__tests__/readme.md +40 -40
  327. package/docs/03-PATTERN-GUIDES/examples/__tests__/resolver-examples.test.js +282 -282
  328. package/docs/03-PATTERN-GUIDES/examples/test-data/03-pattern-guides-readme.md +110 -110
  329. package/docs/03-PATTERN-GUIDES/examples/test-data/canonical-inventory.json +123 -123
  330. package/docs/03-PATTERN-GUIDES/examples/test-data/canonical-order.json +171 -171
  331. package/docs/03-PATTERN-GUIDES/examples/test-data/readme.md +28 -28
  332. package/docs/03-PATTERN-GUIDES/extraction/extraction-readme.md +15 -15
  333. package/docs/03-PATTERN-GUIDES/extraction/readme.md +25 -25
  334. package/docs/03-PATTERN-GUIDES/file-operations/examples/common-patterns.ts +407 -407
  335. package/docs/03-PATTERN-GUIDES/file-operations/examples/file-operations-readme.md +142 -142
  336. package/docs/03-PATTERN-GUIDES/file-operations/file-operations-quick-reference.md +462 -462
  337. package/docs/03-PATTERN-GUIDES/file-operations/file-operations-readme.md +379 -379
  338. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-01-foundations.md +430 -430
  339. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-02-quick-start.md +484 -484
  340. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-03-s3-operations.md +507 -507
  341. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-04-sftp-operations.md +963 -963
  342. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-05-streaming-performance.md +503 -503
  343. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-06-archive-patterns.md +386 -386
  344. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-06-error-handling.md +117 -117
  345. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-07-api-reference.md +78 -78
  346. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-07-testing-troubleshooting.md +567 -567
  347. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-08-api-reference.md +1055 -1055
  348. package/docs/03-PATTERN-GUIDES/file-operations/readme.md +32 -32
  349. package/docs/03-PATTERN-GUIDES/ingestion/ingestion-readme.md +15 -15
  350. package/docs/03-PATTERN-GUIDES/ingestion/readme.md +25 -25
  351. package/docs/03-PATTERN-GUIDES/integration-patterns/examples/batch-processing.ts +130 -130
  352. package/docs/03-PATTERN-GUIDES/integration-patterns/examples/common-patterns.ts +360 -360
  353. package/docs/03-PATTERN-GUIDES/integration-patterns/examples/delta-sync.ts +130 -130
  354. package/docs/03-PATTERN-GUIDES/integration-patterns/examples/integration-patterns-readme.md +100 -100
  355. package/docs/03-PATTERN-GUIDES/integration-patterns/examples/real-time-webhook.ts +398 -398
  356. package/docs/03-PATTERN-GUIDES/integration-patterns/integration-patterns-quick-reference.md +962 -962
  357. package/docs/03-PATTERN-GUIDES/integration-patterns/integration-patterns-readme.md +134 -134
  358. package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-01-real-time-processing.md +991 -991
  359. package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-02-batch-processing.md +1547 -1547
  360. package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-03-delta-sync.md +1108 -1108
  361. package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-04-webhook-patterns.md +1181 -1181
  362. package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-05-error-handling.md +1061 -1061
  363. package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-06-advanced-integration-services.md +1547 -1547
  364. package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-06-performance.md +109 -109
  365. package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-07-api-reference.md +34 -34
  366. package/docs/03-PATTERN-GUIDES/integration-patterns/readme.md +30 -30
  367. package/docs/03-PATTERN-GUIDES/logging-minimal-mode.md +128 -128
  368. package/docs/03-PATTERN-GUIDES/multiple-connections/examples/common-patterns.ts +380 -380
  369. package/docs/03-PATTERN-GUIDES/multiple-connections/examples/multiple-connections-readme.md +139 -139
  370. package/docs/03-PATTERN-GUIDES/multiple-connections/examples/parallel-root-connections.ts +149 -149
  371. package/docs/03-PATTERN-GUIDES/multiple-connections/examples/real-world-scenarios.ts +405 -405
  372. package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-01-foundations.md +378 -378
  373. package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-02-quick-start.md +566 -566
  374. package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-03-targeting-connections.md +659 -659
  375. package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-04-parallel-queries.md +656 -656
  376. package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-05-best-practices.md +624 -624
  377. package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-06-api-reference.md +824 -824
  378. package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-06-versori.md +119 -119
  379. package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-07-api-reference.md +87 -87
  380. package/docs/03-PATTERN-GUIDES/multiple-connections/multiple-connections-quick-reference.md +353 -353
  381. package/docs/03-PATTERN-GUIDES/multiple-connections/multiple-connections-readme.md +270 -270
  382. package/docs/03-PATTERN-GUIDES/multiple-connections/readme.md +30 -30
  383. package/docs/03-PATTERN-GUIDES/pagination/pagination-readme.md +14 -14
  384. package/docs/03-PATTERN-GUIDES/pagination/readme.md +24 -24
  385. package/docs/03-PATTERN-GUIDES/parquet/examples/common-patterns.ts +180 -180
  386. package/docs/03-PATTERN-GUIDES/parquet/examples/read-parquet.ts +48 -48
  387. package/docs/03-PATTERN-GUIDES/parquet/examples/write-parquet.ts +65 -65
  388. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-01-introduction.md +393 -393
  389. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-02-quick-start.md +572 -572
  390. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-03-reading-parquet.md +525 -525
  391. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-04-writing-parquet.md +554 -554
  392. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-05-graphql-extraction.md +405 -405
  393. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-06-performance.md +104 -104
  394. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-06-s3-integration.md +511 -511
  395. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-07-api-reference.md +90 -90
  396. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-07-performance-optimization.md +525 -525
  397. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-08-best-practices.md +712 -712
  398. package/docs/03-PATTERN-GUIDES/parquet/parquet-quick-reference.md +683 -683
  399. package/docs/03-PATTERN-GUIDES/parquet/parquet-readme.md +248 -248
  400. package/docs/03-PATTERN-GUIDES/parquet/readme.md +32 -32
  401. package/docs/03-PATTERN-GUIDES/parsers/parsers-readme.md +12 -12
  402. package/docs/03-PATTERN-GUIDES/parsers/readme.md +24 -24
  403. package/docs/03-PATTERN-GUIDES/readme.md +159 -159
  404. package/docs/03-PATTERN-GUIDES/webhooks/readme.md +24 -24
  405. package/docs/03-PATTERN-GUIDES/webhooks/webhooks-readme.md +8 -8
  406. package/docs/04-REFERENCE/architecture/architecture-01-overview.md +427 -427
  407. package/docs/04-REFERENCE/architecture/architecture-02-client-architecture.md +424 -424
  408. package/docs/04-REFERENCE/architecture/architecture-03-data-flow.md +690 -690
  409. package/docs/04-REFERENCE/architecture/architecture-04-service-layer.md +834 -834
  410. package/docs/04-REFERENCE/architecture/architecture-05-integration-architecture.md +655 -655
  411. package/docs/04-REFERENCE/architecture/architecture-06-state-management.md +653 -653
  412. package/docs/04-REFERENCE/architecture/architecture-adding-new-data-sources.md +686 -686
  413. package/docs/04-REFERENCE/architecture/readme.md +279 -279
  414. package/docs/04-REFERENCE/platforms/deno/readme.md +117 -117
  415. package/docs/04-REFERENCE/platforms/nodejs/readme.md +146 -146
  416. package/docs/04-REFERENCE/platforms/readme.md +135 -135
  417. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-01-introduction.md +398 -398
  418. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-02-quick-start.md +560 -560
  419. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-03-authentication.md +757 -757
  420. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-04-workflows.md +2476 -2476
  421. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-05-connections.md +1167 -1167
  422. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-06-kv-storage.md +990 -990
  423. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-06-state-management.md +121 -121
  424. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-07-api-reference.md +68 -68
  425. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-07-deployment.md +731 -731
  426. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-08-best-practices.md +1111 -1111
  427. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-09-signature-reference.md +766 -766
  428. package/docs/04-REFERENCE/platforms/versori/platforms-versori-readme.md +299 -299
  429. package/docs/04-REFERENCE/platforms/versori/platforms-versori-s3-sftp-configuration-guide.md +1425 -1425
  430. package/docs/04-REFERENCE/platforms/versori/platforms-versori-webhook-api-key-security.md +816 -816
  431. package/docs/04-REFERENCE/platforms/versori/platforms-versori-webhook-connection-security.md +681 -681
  432. package/docs/04-REFERENCE/platforms/versori/platforms-versori-workflow-task-types.md +708 -708
  433. package/docs/04-REFERENCE/platforms/versori/readme.md +108 -108
  434. package/docs/04-REFERENCE/readme.md +148 -148
  435. package/docs/04-REFERENCE/resolver-signature/examples/advanced-resolvers.ts +482 -482
  436. package/docs/04-REFERENCE/resolver-signature/examples/async-resolvers.ts +496 -496
  437. package/docs/04-REFERENCE/resolver-signature/examples/basic-resolvers.ts +343 -343
  438. package/docs/04-REFERENCE/resolver-signature/examples/resolver-signature-readme.md +188 -188
  439. package/docs/04-REFERENCE/resolver-signature/examples/testing-resolvers.ts +463 -463
  440. package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-01-foundations.md +286 -286
  441. package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-02-parameter-reference.md +643 -643
  442. package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-03-basic-examples.md +521 -521
  443. package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-04-advanced-patterns.md +739 -739
  444. package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-05-sdk-resolvers.md +531 -531
  445. package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-06-migration-guide.md +650 -650
  446. package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-06-testing.md +125 -125
  447. package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-07-api-reference.md +794 -794
  448. package/docs/04-REFERENCE/resolver-signature/readme.md +64 -64
  449. package/docs/04-REFERENCE/resolver-signature/resolver-signature-quick-reference.md +270 -270
  450. package/docs/04-REFERENCE/resolver-signature/resolver-signature-readme.md +351 -351
  451. package/docs/04-REFERENCE/schema/fluent-commerce-schema.json +764 -764
  452. package/docs/04-REFERENCE/schema/readme.md +141 -141
  453. package/docs/04-REFERENCE/testing/examples/04-reference-testing-readme.md +158 -158
  454. package/docs/04-REFERENCE/testing/examples/fluent-testing.ts +62 -62
  455. package/docs/04-REFERENCE/testing/examples/health-check.ts +155 -155
  456. package/docs/04-REFERENCE/testing/examples/integration-test.ts +119 -119
  457. package/docs/04-REFERENCE/testing/examples/performance-test.ts +183 -183
  458. package/docs/04-REFERENCE/testing/examples/s3-testing.ts +127 -127
  459. package/docs/04-REFERENCE/testing/modules/04-reference-testing-01-foundations.md +267 -267
  460. package/docs/04-REFERENCE/testing/modules/04-reference-testing-02-s3-testing.md +599 -599
  461. package/docs/04-REFERENCE/testing/modules/04-reference-testing-03-fluent-testing.md +589 -589
  462. package/docs/04-REFERENCE/testing/modules/04-reference-testing-04-integration-testing.md +699 -699
  463. package/docs/04-REFERENCE/testing/modules/04-reference-testing-05-debugging.md +478 -478
  464. package/docs/04-REFERENCE/testing/modules/04-reference-testing-06-cicd-integration.md +463 -463
  465. package/docs/04-REFERENCE/testing/modules/04-reference-testing-06-preflight-validation.md +131 -131
  466. package/docs/04-REFERENCE/testing/modules/04-reference-testing-07-best-practices.md +499 -499
  467. package/docs/04-REFERENCE/testing/modules/04-reference-testing-07-coverage-ci.md +165 -165
  468. package/docs/04-REFERENCE/testing/modules/04-reference-testing-08-api-reference.md +634 -634
  469. package/docs/04-REFERENCE/testing/readme.md +86 -86
  470. package/docs/04-REFERENCE/testing/testing-quick-reference.md +667 -667
  471. package/docs/04-REFERENCE/testing/testing-readme.md +286 -286
  472. package/docs/04-REFERENCE/troubleshooting/readme.md +144 -144
  473. package/docs/04-REFERENCE/troubleshooting/troubleshooting-deno-sftp-compatibility.md +392 -392
  474. package/docs/template-loading-matrix.md +242 -242
  475. package/package.json +5 -3
  476. package/docs/02-CORE-GUIDES/api-reference/cli-profile-integration.md +0 -377
@@ -1,1418 +1,1418 @@
1
- ---
2
- template_id: tpl-webhook-rubix-fulfilment-export-inline
3
- canonical_filename: template-webhook-rubix-fulfilment-to-sftp-xml-inline.md
4
- version: 2.0.0
5
- sdk_version: ^0.1.39
6
- runtime: versori
7
- direction: webhook
8
- source: fluent-rubix-workflow
9
- destination: sftp-xml
10
- entity: fulfilment
11
- format: xml
12
- logging: versori
13
- status: stable
14
- pattern: inline-mapping
15
- features:
16
- - webhook-validation
17
- - fire-and-forget
18
- - background-processing
19
- - xml-export
20
- - sftp-integration
21
- - graphql-queries
22
- - inline-mapping
23
- ---
24
-
25
- # Template: Rubix Fulfilment Webhook → SFTP XML Export (Inline Mapping Pattern)
26
-
27
- **Template Version:** 2.0.0
28
- **SDK Version:** `^0.1.39` - `npm install @fluentcommerce/fc-connect-sdk@^0.1.39`
29
- **Last Updated:** 2025-11-12
30
- **Deployment Target:** Versori Platform
31
- **Mapping Pattern:** 🔵 **INLINE MAPPING** (Simpler, faster, webhook-optimized)
32
-
33
- > **📖 Pattern Selection Guide:**
34
- > - **Use THIS template (Inline)** for: Simple webhooks, tightly-coupled 3PL schemas, fast debugging
35
- > - **Use UniversalMapper version** for: Reusable configs, multi-environment deployments, complex transformations
36
- > - **See also:** [template-webhook-rubix-fulfilment-to-sftp-xml-universal-mapper.md](./template-webhook-rubix-fulfilment-to-sftp-xml-universal-mapper.md)
37
-
38
- **🆕 Version 2.0.0 - Production Ready:**
39
- - ✅ **Fulfilment-specific template** - Focused on 3PL/WMS integration
40
- - ✅ **Production-ready modular structure** - Separate workflows, services, types
41
- - ✅ **GraphQL fulfilment queries** - Fetch fulfilment + line items + order details
42
- - ✅ **Automatic pagination** - Handles fulfilments with 100+ items (up to 1000)
43
- - ✅ **XML generation** - Safe XML with automatic escaping
44
- - ✅ **SFTP upload** - Connection pooling with proper dispose()
45
- - ✅ **Critical fixes applied** - retailerId validation, SFTP options parameter, pagination
46
- - ✅ **Comprehensive documentation** - Testing, troubleshooting, monitoring
47
-
48
- ---
49
-
50
- ## Overview
51
-
52
- Receive fulfilment webhooks from Rubix workflows, query fulfilment details, generate XML, and upload to 3PL/WMS SFTP server.
53
-
54
- **Pattern:**
55
- 1. Validate webhook signature (~10-50ms)
56
- 2. Return HTTP 200 OK immediately (fast acknowledgment)
57
- 3. Background: Query fulfilment details → Generate XML → Upload to SFTP (~2-5s)
58
-
59
- **Business Use Case:**
60
- - Rubix workflow sends webhook when fulfilment is created/updated
61
- - Handler queries fulfilment details (items, order, addresses)
62
- - Generates XML fulfillment notification for 3PL/WMS
63
- - Uploads to partner SFTP server for warehouse processing
64
-
65
- ---
66
-
67
- ## STEP 1: Understand This Template
68
-
69
- ### What This Template Does
70
-
71
- **Core Functionality:**
72
- - Receives FULFILMENT webhooks from Fluent Commerce Rubix workflows
73
- - Validates webhook signature for security
74
- - Returns fast HTTP 200 OK response (<100ms)
75
- - Background: Queries fulfilment via GraphQL → Transforms to XML → Uploads to SFTP
76
-
77
- **Key SDK Components:**
78
- - `WebhookValidationService` - Signature validation with RSA/HMAC support
79
- - `createClient()` - Universal client factory (auto-detects Versori context)
80
- - `client.graphql()` - Query fulfilment details with automatic pagination
81
- - `XMLBuilder` - Safe XML generation with automatic escaping
82
- - `SftpDataSource` - SFTP operations with connection pooling
83
- - `ctx.credentials().getAccessToken()` - Retrieve SFTP credentials from Versori connection vault
84
- - Native Versori `log` - Structured logging from context
85
-
86
- **Pagination Support:**
87
- - Automatically handles fulfilments with 100+ line items
88
- - Uses two-query pattern: fulfilment details + paginated items
89
- - SDK auto-pagination: `pagination: { maxPages: 10 }` supports up to 1000 items
90
- - Logs pagination usage for monitoring
91
-
92
- **Critical Patterns:**
93
- - **Sync + Fire-and-Forget**: Fast validation, background processing
94
- - **Signature Validation**: Always validate `fluent-signature` or `flex.signature` headers
95
- - **Background Promises**: Use `.then().catch()` for error handling
96
- - **SFTP Credentials**: Retrieve from Versori connection vault (not activation variables)
97
- - **SFTP Cleanup**: Always call `dispose()` in finally blocks
98
- - **RetailerId Validation**: Check before `setRetailerId()` to prevent 401 errors
99
-
100
- ### When to Use This Template
101
-
102
- ✅ **USE THIS TEMPLATE FOR:**
103
- - Fulfilment created/updated webhooks from Rubix workflows
104
- - Export fulfilment details to 3PL/WMS via SFTP
105
- - Need XML format for warehouse management systems
106
- - Require signature validation for security
107
- - Need fast webhook acknowledgment + async processing
108
-
109
- ❌ **DON'T USE FOR:**
110
- - Order webhooks (use order attribute update template)
111
- - Inventory webhooks (use inventory templates)
112
- - CSV/JSON exports (use format-specific templates)
113
- - Synchronous processing required (use standard http workflow)
114
-
115
- ### Business Use Cases
116
-
117
- **Use Case: 3PL Warehouse Fulfillment Notification**
118
- - Rubix workflow sends webhook when fulfilment moves to "ALLOCATED" status
119
- - Handler queries fulfilment details (items, quantities, order info)
120
- - Generates XML fulfillment order for warehouse system
121
- - Uploads to 3PL SFTP server for pick/pack/ship processing
122
- - 3PL system imports XML and creates warehouse tasks
123
-
124
- ---
125
-
126
- ## STEP 2: Implementation Prompt for Claude Code
127
-
128
- **Copy this prompt and send to Claude Code to generate the complete implementation:**
129
-
130
- ```
131
- Create a Versori webhook handler for Fluent Commerce Rubix FULFILMENT events with signature validation, GraphQL queries, XML generation, and SFTP upload.
132
-
133
- REQUIREMENTS:
134
- 1. Runtime: Versori Platform (HTTP webhook)
135
- 2. Source: Rubix SendWebhook action (FULFILMENT entity type only)
136
- 3. Destination: SFTP XML export to 3PL/WMS partner
137
- 4. Format: XML with fulfilment details, line items, order info
138
- 5. Entity: FULFILMENT
139
-
140
- KEY FEATURES:
141
- - Webhook signature validation using WebhookValidationService
142
- - Sync mode + fire-and-forget pattern for fast response
143
- - Background processing: GraphQL query → Inline XML mapping → XML generation → SFTP upload
144
- - **Automatic pagination** - Handles fulfilments with 100+ items (up to 1000 items)
145
- - Two-query pattern: Fulfilment details + paginated items query
146
- - **Inline XML mapping** - Manual object construction (simple, no config files)
147
- - **XMLBuilder** - Safe XML generation with automatic escaping
148
- - Modular architecture (workflows/, services/, types/)
149
- - Native Versori logging (no LoggingService)
150
- - SFTP cleanup with dispose() in finally blocks
151
- - Comprehensive error handling with SDK error types
152
- - RetailerId validation before setRetailerId()
153
-
154
- CRITICAL REQUIREMENTS:
155
- 1. Webhook Mode: response: { mode: 'sync' }
156
- 2. Signature Validation: WebhookValidationService with strictValidation: true
157
- 3. RetailerId Validation: Check exists before client.setRetailerId()
158
- 4. Background Processing: Fire-and-forget pattern (no await on background promise)
159
- 5. GraphQL Queries: Two separate queries (fulfilment + items with pagination)
160
- 6. Pagination: Use SDK automatic pagination with maxPages: 10, first: 100
161
- 7. **Inline Mapping**: Manual object construction for XML structure (no external config)
162
- 8. XML Generation: Use XMLBuilder with automatic escaping
163
- 9. SFTP Upload: Include options parameter { overwrite: true, createDirectories: true }
164
- 10. SFTP Cleanup: Always dispose() in finally block
165
- 11. Error Handling: Import and handle DataSourceError, AuthenticationError, GraphQLError
166
- 12. Type Safety: Use Logger, VersoriContext types (not any)
167
-
168
- SDK METHODS TO USE:
169
- - import { Buffer } from 'node:buffer' (CRITICAL for Versori/Deno)
170
- - createClient({ ...ctx, log })
171
- - await client.setRetailerId(retailerId) (with validation first!)
172
- - new WebhookValidationService({ strictValidation: true }, log)
173
- - await validator.validateWebhook(rawBody, headers, publicKey)
174
- - await client.graphql({ query, variables, pagination: { maxPages: 10 } })
175
- - Manual object construction for XML structure (inline mapping)
176
- - new XMLBuilder({ prettyPrint: true, xmlDeclaration: true, encoding: 'UTF-8' })
177
- - xmlBuilder.build(xmlData, 'FulfilmentExport')
178
- - await ctx.credentials().getAccessToken('sftp_export_server') - Retrieve SFTP credentials from connection vault
179
- - Buffer.from(accessToken, 'base64').toString('utf-8') - Decode Basic Auth credentials
180
- - new SftpDataSource(config, log) - config includes connectionId: 'sftp_export_server'
181
- - await sftp.uploadFile(remotePath, buffer, { overwrite: true, createDirectories: true })
182
- - await sftp.dispose() (CRITICAL in finally block)
183
-
184
- FORBIDDEN PATTERNS:
185
- - ❌ LoggingService (use native log from context)
186
- - ❌ await on background processing (use fire-and-forget)
187
- - ❌ Missing dispose() for SFTP
188
- - ❌ Missing options parameter in uploadFile()
189
- - ❌ Missing retailerId validation before setRetailerId()
190
- - ❌ Storing SFTP credentials in activation variables (use Versori connection vault)
191
- - ❌ Using 'any' type (use Logger, VersoriContext from SDK)
192
- - ❌ Direct FluentClient instantiation (use createClient factory)
193
- - ❌ Generic error handling (use SDK error types)
194
-
195
- GRAPHQL QUERY STRUCTURE:
196
-
197
- **Single Query with Nested Items (Schema-Validated)**
198
- ```graphql
199
- query GetFulfilment($id: ID!, $first: Int!, $after: String) {
200
- fulfilment(id: $id) {
201
- id
202
- ref
203
- status
204
- deliveryType
205
- order {
206
- id
207
- ref
208
- customer { firstName, lastName, email }
209
- }
210
- toAddress {
211
- name, street, street2, city, state, postcode, country
212
- }
213
- fromAddress {
214
- name, street, street2, city, state, postcode, country
215
- }
216
- items(first: $first, after: $after) {
217
- edges {
218
- node {
219
- id
220
- ref
221
- requestedQuantity
222
- filledQuantity
223
- rejectedQuantity
224
- orderItem {
225
- id
226
- ref
227
- productRef
228
- product { name }
229
- }
230
- }
231
- cursor
232
- }
233
- pageInfo {
234
- hasNextPage
235
- }
236
- }
237
- createdOn
238
- updatedOn
239
- }
240
- }
241
- ```
242
-
243
- **Why Single Query?**
244
- - Items are nested under the fulfilment type in Fluent Commerce schema
245
- - Single query with `connectionPath: 'fulfilment.items'` for SDK pagination
246
- - SDK automatically handles pagination with `pagination: { maxPages: 10 }` config
247
- - More efficient than two separate queries (reduces GraphQL roundtrips)
248
-
249
- XML OUTPUT STRUCTURE:
250
- <FulfilmentExport>
251
- <Fulfilment ref="FF-001" status="ALLOCATED">
252
- <OrderRef>ORD-123</OrderRef>
253
- <DeliveryType>STANDARD</DeliveryType>
254
- <Customer>
255
- <FirstName>John</FirstName>
256
- <LastName>Smith</LastName>
257
- <Email>john@example.com</Email>
258
- </Customer>
259
- <ToAddress>
260
- <Name>John Smith</Name>
261
- <Street>123 Main St</Street>
262
- <Street2>Apt 4B</Street2>
263
- <City>New York</City>
264
- <State>NY</State>
265
- <Postcode>10001</Postcode>
266
- <Country>US</Country>
267
- </ToAddress>
268
- <FromAddress>
269
- <Name>Warehouse</Name>
270
- <Street>456 Warehouse St</Street>
271
- <City>Chicago</City>
272
- <State>IL</State>
273
- <Postcode>60601</Postcode>
274
- <Country>US</Country>
275
- </FromAddress>
276
- <Items>
277
- <Item ref="FFI-001">
278
- <ProductRef>SKU-001</ProductRef>
279
- <ProductName>Widget</ProductName>
280
- <RequestedQuantity>2</RequestedQuantity>
281
- <FilledQuantity>2</FilledQuantity>
282
- <RejectedQuantity>0</RejectedQuantity>
283
- </Item>
284
- </Items>
285
- <CreatedOn>2025-01-25T10:00:00Z</CreatedOn>
286
- <UpdatedOn>2025-01-25T11:00:00Z</UpdatedOn>
287
- </Fulfilment>
288
- </FulfilmentExport>
289
-
290
- GENERATE:
291
- 1. package.json with dependencies
292
- 2. index.ts (entry point - exports workflow)
293
- 3. src/workflows/webhook/fulfilment-export-handler.ts (webhook entry)
294
- 4. src/services/fulfilment-query.service.ts (GraphQL queries)
295
- 5. src/services/xml-export.service.ts (Inline XML mapping + XMLBuilder + SFTP upload)
296
- 6. src/types/fulfilment.types.ts (TypeScript interfaces)
297
- 7. readme.md with setup instructions
298
-
299
- Ensure all code is production-ready with proper error handling, signature validation, SFTP cleanup, inline XML mapping, and type safety.
300
- ```
301
-
302
- ---
303
-
304
- ## STEP 3: Detailed Flow Documentation
305
-
306
- ### Complete Processing Flow
307
-
308
- ```
309
- ┌─────────────────────────────────────────────────────────────┐
310
- │ 1. RUBIX WEBHOOK RECEIVED │
311
- │ POST https://{workspace}.versori.run/rubix-fulfilment │
312
- │ Headers: fluent-signature │
313
- │ Body: { entityRef: "FF-001", entityType: "FULFILMENT" } │
314
- └────────────────────┬────────────────────────────────────────┘
315
-
316
-
317
- ┌─────────────────────────────────────────────────────────────┐
318
- │ 2. SIGNATURE VALIDATION (Synchronous, ~10-50ms) │
319
- │ - Extract rawBody and headers │
320
- │ - Get fluentPublicKey from activation │
321
- │ - WebhookValidationService.validateWebhook() │
322
- │ - Return 400 if invalid │
323
- └────────────────────┬────────────────────────────────────────┘
324
-
325
-
326
- ┌─────────────────────────────────────────────────────────────┐
327
- │ 3. PAYLOAD VALIDATION (Synchronous, ~5ms) │
328
- │ - Check entityRef exists │
329
- │ - Check entityType === 'FULFILMENT' │
330
- │ - Check retailerId exists │
331
- │ - Return 400 if missing required fields │
332
- └────────────────────┬────────────────────────────────────────┘
333
-
334
-
335
- ┌─────────────────────────────────────────────────────────────┐
336
- │ 4. HTTP 200 OK RESPONSE (Total: ~50ms) │
337
- │ - Return success immediately │
338
- │ - Background promise continues (fire-and-forget) │
339
- └────────────────────┬────────────────────────────────────────┘
340
-
341
- ▼ (Background - doesn't block response)
342
- ┌─────────────────────────────────────────────────────────────┐
343
- │ 5. BACKGROUND PROCESSING (~2-5 seconds) │
344
- │ ┌─────────────────────────────────────────────────────┐ │
345
- │ │ 5a. Initialize Fluent Client (~100ms) │ │
346
- │ │ - createClient({ ...ctx, log }) │ │
347
- │ │ - Validate retailerId exists │ │
348
- │ │ - client.setRetailerId(retailerId) │ │
349
- │ └─────────────────────────────────────────────────────┘ │
350
- │ ┌─────────────────────────────────────────────────────┐ │
351
- │ │ 5b. Query Fulfilment Details (~500-1500ms) │ │
352
- │ │ - GraphQL query with nested fields │ │
353
- │ │ - Fulfilment + items + order + addresses │ │
354
- │ │ - Handle GraphQLError if query fails │ │
355
- │ └─────────────────────────────────────────────────────┘ │
356
- │ ┌─────────────────────────────────────────────────────┐ │
357
- │ │ 5c. Generate XML (~50ms) │ │
358
- │ │ - Inline XML structure construction │ │
359
- │ │ - XMLBuilder handles escaping automatically │ │
360
- │ │ - Create Buffer from XML string │ │
361
- │ └─────────────────────────────────────────────────────┘ │
362
- │ ┌─────────────────────────────────────────────────────┐ │
363
- │ │ 5d. Upload to SFTP (~500-2000ms) │ │
364
- │ │ - Initialize SftpDataSource │ │
365
- │ │ - Upload with options parameter │ │
366
- │ │ - Handle DataSourceError if upload fails │ │
367
- │ │ - ALWAYS dispose() in finally block │ │
368
- │ └─────────────────────────────────────────────────────┘ │
369
- │ ┌─────────────────────────────────────────────────────┐ │
370
- │ │ 5e. Log Completion │ │
371
- │ │ - Success: Log fulfilment ref and duration │ │
372
- │ │ - Failure: Log error with category │ │
373
- │ └─────────────────────────────────────────────────────┘ │
374
- └─────────────────────────────────────────────────────────────┘
375
- ```
376
-
377
- ### Response Timing
378
-
379
- | Stage | Timing | Blocking |
380
- |-------|--------|----------|
381
- | **Signature Validation** | ~10-50ms | ✅ Yes (blocks response) |
382
- | **Payload Validation** | ~5ms | ✅ Yes (blocks response) |
383
- | **HTTP 200 Response** | ~50-100ms | ✅ Fast acknowledgment |
384
- | **GraphQL Query** | ~500-1500ms | ❌ No (background) |
385
- | **XML Generation** | ~50ms | ❌ No (background) |
386
- | **SFTP Upload** | ~500-2000ms | ❌ No (background) |
387
- | **Total Background** | ~2000-5000ms | ❌ Fire-and-forget |
388
-
389
- ---
390
-
391
- ## STEP 4: Production Modular Structure
392
-
393
- ### Complete Project Structure
394
-
395
- ```
396
- rubix-fulfilment-export/
397
- ├── package.json # Dependencies and Versori config
398
- ├── tsconfig.json # TypeScript configuration
399
- ├── readme.md # Setup and deployment instructions
400
- ├── index.ts # Entry point - exports workflow
401
- └── src/
402
- ├── workflows/
403
- │ └── webhook/
404
- │ └── fulfilment-export-handler.ts # Webhook entry point
405
-
406
- ├── services/
407
- │ ├── fulfilment-query.service.ts # GraphQL queries
408
- │ └── xml-export.service.ts # Inline XML mapping + XMLBuilder + SFTP upload
409
-
410
- └── types/
411
- └── fulfilment.types.ts # TypeScript interfaces
412
- ```
413
-
414
- **Why This Structure?**
415
- - ✅ **Clear separation**: Webhook handlers vs business logic
416
- - ✅ **Reusable services**: Query and export logic can be unit tested
417
- - ✅ **Simple inline mapping**: XML structure defined directly in code (no config files)
418
- - ✅ **Type safety**: TypeScript interfaces for better IDE support
419
- - ✅ **Scalable**: Easy to add more fulfilment webhooks
420
- - ✅ **Testable**: Services can be mocked and tested independently
421
- - ✅ **Fast debugging**: XML structure visible directly in code
422
-
423
- ---
424
-
425
- ## SDK Imports (Verified - Versori Optimized)
426
-
427
- ```typescript
428
- // CRITICAL: Buffer import required for Versori/Deno runtime
429
- import { Buffer } from 'node:buffer';
430
-
431
- // FC Connect SDK imports
432
- import {
433
- createClient,
434
- WebhookValidationService,
435
- XMLBuilder,
436
- SftpDataSource,
437
- DataSourceError,
438
- AuthenticationError,
439
- GraphQLError,
440
- type Logger,
441
- type VersoriContext,
442
- } from '@fluentcommerce/fc-connect-sdk';
443
-
444
- // Versori platform imports
445
- import { webhook } from '@versori/run';
446
- import type { Context } from '@versori/run';
447
- ```
448
-
449
- ---
450
-
451
- ## Configuration
452
-
453
- ### Activation Variables
454
-
455
- ```json
456
- {
457
- "fluentPublicKey": "-----BEGIN PUBLIC KEY-----...-----END PUBLIC KEY-----",
458
- "sftpHost": "sftp.3pl-partner.com",
459
- "sftpPort": 22,
460
- "sftpRemotePath": "/incoming/fulfilments/"
461
- }
462
- ```
463
-
464
- > **Important:** `sftpUsername` and `sftpPassword` are **NOT** stored in activation variables. They are securely retrieved from the `sftp_export_server` connection vault at runtime. See the SFTP Credential Management section below for details.
465
-
466
- ### Connections
467
-
468
- | Connection | Description | Required |
469
- |------------|-------------|----------|
470
- | `fluent_commerce` | OAuth2 connection to Fluent Commerce | Yes |
471
- | `sftp_export_server` | Basic Auth connection for SFTP credentials (username/password) | Yes |
472
-
473
- ## SFTP Credential Management
474
-
475
- Fetch credentials securely from Versori connection vault using `ctx.credentials().getAccessToken()`:
476
-
477
- **Benefits:**
478
- - ✅ Credentials stored securely in Versori vault
479
- - ✅ Centralized management - update in one place
480
- - ✅ Access control enforced by platform
481
- - ✅ No credentials in activation variables
482
- - ✅ Explicit error handling with validation
483
-
484
- ### Setup Steps
485
-
486
- 1. In Versori Dashboard → Connections → Add Connection
487
- 2. Name: `sftp_export_server`
488
- 3. Type: Basic Auth
489
- 4. Enter SFTP username and password
490
- 5. Save connection
491
- 6. Reference in code: `ctx.credentials().getAccessToken('sftp_export_server')`
492
-
493
- ---
494
-
495
- ## Complete Working Code
496
-
497
- ### 1. Entry Point (index.ts)
498
-
499
- ```typescript
500
- /**
501
- * Entry point - Export webhook workflow for Versori platform
502
- */
503
-
504
- export { rubixFulfilmentExportHandler } from './src/workflows/webhook/fulfilment-export-handler';
505
- ```
506
-
507
- ### 2. Webhook Handler (src/workflows/webhook/fulfilment-export-handler.ts)
508
-
509
- ```typescript
510
- /**
511
- * Rubix Fulfilment Webhook Handler → SFTP XML Export
512
- *
513
- * Direction: Fluent Rubix Workflow (FULFILMENT) → Versori → GraphQL → XML → SFTP
514
- */
515
-
516
- import { Buffer } from 'node:buffer';
517
- import { webhook } from '@versori/run';
518
- import type { Context } from '@versori/run';
519
- import {
520
- WebhookValidationService,
521
- type Logger,
522
- } from '@fluentcommerce/fc-connect-sdk';
523
- import { processFulfilmentExport } from '../../services/fulfilment-query.service';
524
-
525
- export const rubixFulfilmentExportHandler = webhook('rubix-fulfilment', {
526
- response: { mode: 'sync' }, // ✅ Sync mode: response sent when handler returns
527
- }, async (ctx: Context<any>) => {
528
- const { log, activation } = ctx;
529
-
530
- log.info('🚀 [WEBHOOK] Received Rubix fulfilment webhook', {
531
- timestamp: new Date().toISOString(),
532
- correlationId: activation?.id,
533
- });
534
-
535
- // ========================================
536
- // STEP 1: VALIDATE SIGNATURE (Synchronous)
537
- // ========================================
538
-
539
- const publicKey = activation.getVariable('fluentPublicKey');
540
- if (!publicKey) {
541
- log.error('❌ [WEBHOOK] Missing fluentPublicKey configuration');
542
- return {
543
- status: 500,
544
- body: {
545
- success: false,
546
- error: 'Missing fluentPublicKey configuration',
547
- recommendation: 'Configure fluentPublicKey in activation variables',
548
- },
549
- };
550
- }
551
-
552
- // Extract raw body (Versori provides parsed data in ctx.data)
553
- const rawBody = typeof ctx.data === 'string' ? ctx.data : JSON.stringify(ctx.data);
554
-
555
- // Extract headers from request (ctx.request() is a function call)
556
- const req = ctx.request?.() || {};
557
- const headersObj = req.headers || {};
558
- const headers = headersObj instanceof Headers
559
- ? Object.fromEntries(headersObj.entries())
560
- : headersObj;
561
-
562
- log.info('🔍 [WEBHOOK] Validating webhook signature');
563
-
564
- const validator = new WebhookValidationService({ strictValidation: true }, log as Logger);
565
- const result = await validator.validateWebhook(rawBody, headers, publicKey);
566
-
567
- if (!result.isValid) {
568
- log.error('❌ [WEBHOOK] Invalid webhook signature', {
569
- error: result.error,
570
- algorithm: result.algorithm,
571
- });
572
- return {
573
- status: 401,
574
- body: {
575
- success: false,
576
- error: 'Invalid webhook signature',
577
- recommendation: 'Verify fluentPublicKey matches Fluent environment',
578
- },
579
- };
580
- }
581
-
582
- log.info('✅ [WEBHOOK] Signature validated successfully', {
583
- algorithm: result.algorithm,
584
- });
585
-
586
- // ========================================
587
- // STEP 2: VALIDATE PAYLOAD (Synchronous)
588
- // ========================================
589
-
590
- const payload = typeof ctx.data === 'string' ? JSON.parse(ctx.data) : ctx.data;
591
- const { entityRef, entityType, retailerId } = payload;
592
-
593
- if (!entityRef) {
594
- log.error('❌ [WEBHOOK] Missing entityRef in payload', { payload });
595
- return {
596
- status: 400,
597
- body: {
598
- success: false,
599
- error: 'Missing entityRef in payload',
600
- recommendation: 'Ensure Rubix SendWebhook includes fulfilment ref',
601
- },
602
- };
603
- }
604
-
605
- if (entityType !== 'FULFILMENT') {
606
- log.error('❌ [WEBHOOK] Invalid entity type', { entityType, expected: 'FULFILMENT' });
607
- return {
608
- status: 400,
609
- body: {
610
- success: false,
611
- error: `Invalid entity type: ${entityType}. Expected: FULFILMENT`,
612
- recommendation: 'Use order-attribute-update template for ORDER webhooks',
613
- },
614
- };
615
- }
616
-
617
- if (!retailerId) {
618
- log.error('❌ [WEBHOOK] Missing retailerId in payload', { payload });
619
- return {
620
- status: 400,
621
- body: {
622
- success: false,
623
- error: 'Missing retailerId in payload',
624
- recommendation: 'Ensure Rubix SendWebhook includes retailerId',
625
- },
626
- };
627
- }
628
-
629
- log.info('✅ [WEBHOOK] Validation passed, starting background processing', {
630
- entityRef,
631
- entityType,
632
- retailerId,
633
- });
634
-
635
- // ========================================
636
- // STEP 3: FIRE-AND-FORGET BACKGROUND PROCESSING
637
- // ========================================
638
-
639
- // ✅ Fire-and-forget: Start background processing WITHOUT await
640
- // The promise continues execution after we return the response
641
- processFulfilmentExport(ctx, payload)
642
- .then(() => {
643
- log.info('✅ [BACKGROUND] Fulfilment exported successfully', {
644
- fulfilmentRef: entityRef,
645
- });
646
- })
647
- .catch((error: unknown) => {
648
- const errorMessage = error instanceof Error ? error.message : String(error);
649
- log.error('❌ [BACKGROUND] Fulfilment export failed', {
650
- fulfilmentRef: entityRef,
651
- error: errorMessage,
652
- stack: error instanceof Error ? error.stack : undefined,
653
- errorType: error instanceof Error ? error.constructor.name : typeof error,
654
- });
655
- });
656
-
657
- // Return immediately (response sent with this return value)
658
- return {
659
- status: 200,
660
- body: {
661
- success: true,
662
- entityType,
663
- fulfilmentRef: entityRef,
664
- message: 'Webhook validated and export started in background',
665
- timestamp: new Date().toISOString(),
666
- correlationId: activation?.id,
667
- },
668
- };
669
- });
670
- ```
671
-
672
- ### 3. Fulfilment Query Service (src/services/fulfilment-query.service.ts)
673
-
674
- ```typescript
675
- /**
676
- * Fulfilment Query Service
677
- *
678
- * Handles GraphQL queries for fulfilment details and orchestrates XML export
679
- */
680
-
681
- import {
682
- createClient,
683
- DataSourceError,
684
- AuthenticationError,
685
- GraphQLError,
686
- type Logger,
687
- type VersoriContext,
688
- } from '@fluentcommerce/fc-connect-sdk';
689
- import { exportFulfilmentToSFTP } from './xml-export.service';
690
- import type { RubixFulfilmentPayload, FulfilmentData } from '../types/fulfilment.types';
691
-
692
- // Single query with nested items (schema-validated structure)
693
- const FULFILMENT_QUERY = `
694
- query GetFulfilment($id: ID!, $first: Int!, $after: String) {
695
- fulfilment(id: $id) {
696
- id
697
- ref
698
- status
699
- deliveryType
700
- order {
701
- id
702
- ref
703
- customer {
704
- firstName
705
- lastName
706
- email
707
- }
708
- }
709
- toAddress {
710
- name
711
- street
712
- street2
713
- city
714
- state
715
- postcode
716
- country
717
- }
718
- fromAddress {
719
- name
720
- street
721
- street2
722
- city
723
- state
724
- postcode
725
- country
726
- }
727
- items(first: $first, after: $after) {
728
- edges {
729
- node {
730
- id
731
- ref
732
- requestedQuantity
733
- filledQuantity
734
- rejectedQuantity
735
- orderItem {
736
- id
737
- ref
738
- productRef
739
- product {
740
- name
741
- }
742
- }
743
- }
744
- cursor
745
- }
746
- pageInfo {
747
- hasNextPage
748
- }
749
- }
750
- createdOn
751
- updatedOn
752
- }
753
- }
754
- `;
755
-
756
- export async function processFulfilmentExport(
757
- ctx: VersoriContext,
758
- payload: RubixFulfilmentPayload
759
- ): Promise<void> {
760
- const log = ctx.log as Logger;
761
- const { entityRef, retailerId } = payload;
762
-
763
- const processingStartTime = Date.now();
764
-
765
- log.info('🔄 [BACKGROUND] Starting fulfilment export', {
766
- timestamp: new Date().toISOString(),
767
- fulfilmentRef: entityRef,
768
- });
769
-
770
- try {
771
- // ========================================
772
- // STEP 1: VALIDATE RETAILER ID
773
- // ========================================
774
-
775
- if (!retailerId) {
776
- log.error('❌ [BACKGROUND] Missing retailerId in payload', {
777
- fulfilmentRef: entityRef,
778
- });
779
- throw new Error('retailerId is required for GraphQL operations');
780
- }
781
-
782
- // ========================================
783
- // STEP 2: INITIALIZE FLUENT CLIENT
784
- // ========================================
785
-
786
- const client = await createClient({ ...ctx, log });
787
- await client.setRetailerId(retailerId);
788
-
789
- // ========================================
790
- // STEP 3: QUERY FULFILMENT WITH NESTED ITEMS
791
- // ========================================
792
-
793
- log.info('🔍 [BACKGROUND] Querying fulfilment with items', { fulfilmentRef: entityRef });
794
-
795
- const result = await client.graphql({
796
- query: FULFILMENT_QUERY,
797
- variables: {
798
- id: entityRef, // ✅ Use 'id' parameter (schema-validated)
799
- first: 100,
800
- },
801
- pagination: {
802
- connectionPath: 'fulfilment.items', // ✅ Nested connection pagination
803
- maxPages: 10, // Handles up to 1000 items (100 per page × 10 pages)
804
- },
805
- });
806
-
807
- const fulfilmentData = result.data?.fulfilment as FulfilmentData | null;
808
-
809
- if (!fulfilmentData) {
810
- log.error('❌ [BACKGROUND] Fulfilment not found', { fulfilmentRef: entityRef });
811
- throw new Error(`Fulfilment not found: ${entityRef}`);
812
- }
813
-
814
- const itemCount = fulfilmentData.items?.edges?.length || 0;
815
-
816
- log.info('✅ [BACKGROUND] Fulfilment and items queried successfully', {
817
- fulfilmentRef: fulfilmentData.ref,
818
- status: fulfilmentData.status,
819
- itemCount,
820
- orderRef: fulfilmentData.order?.ref,
821
- paginationUsed: result.metadata?.totalPages > 1,
822
- });
823
-
824
- // ========================================
825
- // STEP 5: EXPORT TO SFTP
826
- // ========================================
827
-
828
- await exportFulfilmentToSFTP(ctx, completeFullfilmentData, log);
829
-
830
- const duration = Date.now() - processingStartTime;
831
- log.info('✅ [BACKGROUND] Fulfilment export completed', {
832
- fulfilmentRef: entityRef,
833
- duration: `${duration}ms`,
834
- });
835
- } catch (error: unknown) {
836
- let errorMessage = 'Unknown error';
837
- let recommendation: string | undefined;
838
- let errorCategory = 'UNKNOWN';
839
-
840
- if (error instanceof GraphQLError) {
841
- errorMessage = error.message;
842
- recommendation = 'Review GraphQL query syntax and field permissions';
843
- errorCategory = 'GRAPHQL';
844
- } else if (error instanceof AuthenticationError) {
845
- errorMessage = error.message;
846
- recommendation = 'Verify Fluent Commerce credentials and retailerId';
847
- errorCategory = 'AUTHENTICATION';
848
- } else if (error instanceof DataSourceError) {
849
- errorMessage = error.message;
850
- recommendation = 'Check SFTP configuration and connectivity';
851
- errorCategory = 'DATA_SOURCE';
852
- } else if (error instanceof Error) {
853
- errorMessage = error.message;
854
- } else {
855
- errorMessage = String(error);
856
- }
857
-
858
- log.error('❌ [BACKGROUND] Fulfilment export failed', {
859
- fulfilmentRef: entityRef,
860
- error: errorMessage,
861
- errorCategory,
862
- recommendation,
863
- stack: error instanceof Error ? error.stack : undefined,
864
- errorType: error instanceof Error ? error.constructor.name : typeof error,
865
- });
866
-
867
- throw error;
868
- }
869
- }
870
- ```
871
-
872
- ### 4. XML Export Service (src/services/xml-export.service.ts)
873
-
874
- ```typescript
875
- /**
876
- * XML Export Service
877
- *
878
- * Handles XML generation and SFTP upload for fulfilment exports
879
- * Uses inline mapping (manual object construction) for XML structure
880
- */
881
-
882
- import { Buffer } from 'node:buffer';
883
- import {
884
- XMLBuilder,
885
- SftpDataSource,
886
- type Logger,
887
- type VersoriContext,
888
- } from '@fluentcommerce/fc-connect-sdk';
889
- import type { FulfilmentData } from '../types/fulfilment.types';
890
-
891
- export async function exportFulfilmentToSFTP(
892
- ctx: VersoriContext,
893
- fulfilmentData: FulfilmentData,
894
- log: Logger
895
- ): Promise<void> {
896
- const { activation } = ctx;
897
-
898
- log.info('📝 [BACKGROUND] Generating XML for fulfilment', {
899
- fulfilmentRef: fulfilmentData.ref,
900
- });
901
-
902
- // ========================================
903
- // STEP 1: BUILD XML STRUCTURE (INLINE MAPPING)
904
- // ========================================
905
-
906
- const xmlBuilder = new XMLBuilder({
907
- prettyPrint: true,
908
- xmlDeclaration: true,
909
- encoding: 'UTF-8',
910
- });
911
-
912
- // Inline XML structure construction
913
- const xmlData = {
914
- Fulfilment: {
915
- '@ref': fulfilmentData.ref,
916
- '@status': fulfilmentData.status,
917
- OrderRef: fulfilmentData.order?.ref || '',
918
- DeliveryType: fulfilmentData.deliveryType || '',
919
- Customer: fulfilmentData.order?.customer
920
- ? {
921
- FirstName: fulfilmentData.order.customer.firstName || '',
922
- LastName: fulfilmentData.order.customer.lastName || '',
923
- Email: fulfilmentData.order.customer.email || '',
924
- }
925
- : {},
926
- ToAddress: fulfilmentData.toAddress
927
- ? {
928
- Name: fulfilmentData.toAddress.name || '',
929
- Street: fulfilmentData.toAddress.street || '',
930
- Street2: fulfilmentData.toAddress.street2 || '',
931
- City: fulfilmentData.toAddress.city || '',
932
- State: fulfilmentData.toAddress.state || '',
933
- Postcode: fulfilmentData.toAddress.postcode || '',
934
- Country: fulfilmentData.toAddress.country || '',
935
- }
936
- : {},
937
- FromAddress: fulfilmentData.fromAddress
938
- ? {
939
- Name: fulfilmentData.fromAddress.name || '',
940
- Street: fulfilmentData.fromAddress.street || '',
941
- Street2: fulfilmentData.fromAddress.street2 || '',
942
- City: fulfilmentData.fromAddress.city || '',
943
- State: fulfilmentData.fromAddress.state || '',
944
- Postcode: fulfilmentData.fromAddress.postcode || '',
945
- Country: fulfilmentData.fromAddress.country || '',
946
- }
947
- : {},
948
- Items: {
949
- Item:
950
- fulfilmentData.items?.edges?.map(edge => ({
951
- '@ref': edge.node.ref,
952
- ProductRef: edge.node.orderItem?.productRef || '',
953
- ProductName: edge.node.orderItem?.product?.name || '',
954
- RequestedQuantity: edge.node.requestedQuantity || 0,
955
- FilledQuantity: edge.node.filledQuantity,
956
- RejectedQuantity: edge.node.rejectedQuantity,
957
- })) || [],
958
- },
959
- CreatedOn: fulfilmentData.createdOn,
960
- UpdatedOn: fulfilmentData.updatedOn,
961
- },
962
- };
963
-
964
- const xmlString = xmlBuilder.build(xmlData, 'FulfilmentExport');
965
- const xmlBuffer = Buffer.from(xmlString, 'utf8');
966
-
967
- log.info('✅ [BACKGROUND] XML generated successfully', {
968
- fulfilmentRef: fulfilmentData.ref,
969
- xmlSizeBytes: xmlBuffer.length,
970
- xmlSizeKB: Math.round(xmlBuffer.length / 1024),
971
- });
972
-
973
- // ========================================
974
- // STEP 2: UPLOAD TO SFTP
975
- // ========================================
976
-
977
- log.info('📤 [BACKGROUND] Preparing SFTP upload', {
978
- fulfilmentRef: fulfilmentData.ref,
979
- });
980
-
981
- // ========================================
982
- // SFTP CREDENTIAL RETRIEVAL
983
- // ========================================
984
-
985
- /**
986
- * Retrieve SFTP credentials from connection configuration
987
- *
988
- * Connection Name: 'sftp_export_server' (must match the connection name in Versori UI)
989
- * Auth Type: Basic Authentication (username + password)
990
- */
991
- log.info('🔐 [BACKGROUND] Retrieving SFTP credentials from connection configuration');
992
-
993
- let sftpUsername: string;
994
- let sftpPassword: string;
995
-
996
- try {
997
- // Retrieve credentials from the 'sftp_export_server' connection
998
- const sftpCred = await ctx.credentials().getAccessToken('sftp_export_server');
999
-
1000
- if (!sftpCred?.accessToken) {
1001
- throw new Error('No SFTP credentials found in connection configuration');
1002
- }
1003
-
1004
- // Decode base64 accessToken to get "username:password"
1005
- const rawBasicAuth = Buffer.from(sftpCred.accessToken, 'base64').toString('utf-8');
1006
-
1007
- // Split on ':' to extract username and password
1008
- const parts = rawBasicAuth.split(':');
1009
-
1010
- if (parts.length !== 2) {
1011
- throw new Error('Invalid SFTP credential format - expected username:password');
1012
- }
1013
-
1014
- sftpUsername = parts[0];
1015
- sftpPassword = parts[1];
1016
-
1017
- log.info('✅ [BACKGROUND] SFTP credentials retrieved successfully', {
1018
- hasUsername: !!sftpUsername,
1019
- hasPassword: !!sftpPassword,
1020
- usernameLength: sftpUsername.length,
1021
- passwordLength: sftpPassword.length,
1022
- });
1023
- } catch (error: any) {
1024
- log.error('❌ [BACKGROUND] Failed to retrieve SFTP credentials', {
1025
- message: error instanceof Error ? error.message : String(error),
1026
- stack: error instanceof Error ? error.stack : undefined,
1027
- errorType: error instanceof Error ? error.constructor.name : 'Error',
1028
- recommendation: 'Please ensure the SFTP connection "sftp_export_server" is configured in the Connections section with Basic Authentication (username and password)',
1029
- });
1030
- throw new Error(
1031
- `Failed to retrieve SFTP credentials from connection configuration: ${error instanceof Error ? error.message : String(error)}. ` +
1032
- 'Please ensure the SFTP connection is configured in the Connections section with Basic Authentication (username and password)'
1033
- );
1034
- }
1035
-
1036
- // Get SFTP configuration from activation variables
1037
- const sftpHost = activation.getVariable('sftpHost');
1038
- const sftpPort = parseInt(activation.getVariable('sftpPort') || '22', 10);
1039
- const sftpRemotePath = activation.getVariable('sftpRemotePath') || '/incoming/fulfilments/';
1040
-
1041
- if (!sftpHost) {
1042
- log.error('⚠️ [BACKGROUND] SFTP configuration missing', {
1043
- recommendation: 'Configure sftpHost activation variable',
1044
- fulfilmentRef: fulfilmentData.ref,
1045
- });
1046
- throw new Error('SFTP configuration missing: sftpHost is required');
1047
- }
1048
-
1049
- const sftpConfig = {
1050
- type: 'SFTP_XML' as const,
1051
- connectionId: 'sftp_export_server',
1052
- name: 'Fulfilment XML Export',
1053
- settings: {
1054
- host: sftpHost,
1055
- port: sftpPort,
1056
- username: sftpUsername,
1057
- password: sftpPassword,
1058
- },
1059
- };
1060
-
1061
- const sftp = new SftpDataSource(sftpConfig, log);
1062
-
1063
- try {
1064
- const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
1065
- const fileName = `fulfilment-${fulfilmentData.ref}-${timestamp}.xml`;
1066
- const remoteFilePath = `${sftpRemotePath}${fileName}`;
1067
-
1068
- // ✅ CRITICAL FIX: Include options parameter
1069
- await sftp.uploadFile(remoteFilePath, xmlBuffer, {
1070
- overwrite: true,
1071
- createDirectories: true,
1072
- });
1073
-
1074
- log.info('✅ [BACKGROUND] Fulfilment XML exported to SFTP', {
1075
- fulfilmentRef: fulfilmentData.ref,
1076
- remoteFilePath,
1077
- status: fulfilmentData.status,
1078
- fileSizeKB: Math.round(xmlBuffer.length / 1024),
1079
- });
1080
- } finally {
1081
- // ✅ CRITICAL: Always dispose SFTP connection
1082
- await sftp.dispose();
1083
- log.info('🔌 [BACKGROUND] SFTP connection disposed');
1084
- }
1085
- }
1086
- ```
1087
-
1088
- ### 5. Type Definitions (src/types/fulfilment.types.ts)
1089
-
1090
- ```typescript
1091
- /**
1092
- * Type definitions for Rubix fulfilment webhooks and GraphQL responses
1093
- */
1094
-
1095
- export interface RubixFulfilmentPayload {
1096
- id: string;
1097
- name: string;
1098
- accountId: string;
1099
- retailerId: string;
1100
- entityRef: string;
1101
- entityType: 'FULFILMENT';
1102
- entityStatus?: string;
1103
- type: 'NORMAL' | string;
1104
- rootEntityId?: string;
1105
- rootEntityType?: string;
1106
- rootEntityRef?: string;
1107
- attributes?: Record<string, any>;
1108
- context?: Record<string, any>;
1109
- }
1110
-
1111
- export interface FulfilmentData {
1112
- id: string;
1113
- ref: string;
1114
- status: string;
1115
- deliveryType: string;
1116
- order?: {
1117
- id: string;
1118
- ref: string;
1119
- customer?: {
1120
- firstName: string;
1121
- lastName: string;
1122
- email: string;
1123
- };
1124
- };
1125
- items?: {
1126
- edges?: Array<{
1127
- node: {
1128
- id: string;
1129
- ref: string;
1130
- requestedQuantity?: number;
1131
- filledQuantity: number;
1132
- rejectedQuantity: number;
1133
- orderItem?: {
1134
- id: string;
1135
- ref: string;
1136
- productRef: string;
1137
- product?: {
1138
- name: string;
1139
- };
1140
- };
1141
- };
1142
- }>;
1143
- };
1144
- toAddress?: {
1145
- name?: string;
1146
- street?: string;
1147
- street2?: string;
1148
- city?: string;
1149
- state?: string;
1150
- postcode?: string;
1151
- country?: string;
1152
- };
1153
- fromAddress?: {
1154
- name?: string;
1155
- street?: string;
1156
- street2?: string;
1157
- city?: string;
1158
- state?: string;
1159
- postcode?: string;
1160
- country?: string;
1161
- };
1162
- createdOn: string;
1163
- updatedOn: string;
1164
- }
1165
- ```
1166
-
1167
- ### 6. Package Configuration (package.json)
1168
-
1169
- ```json
1170
- {
1171
- "name": "rubix-fulfilment-export",
1172
- "version": "2.0.0",
1173
- "description": "Rubix fulfilment webhook handler with SFTP XML export",
1174
- "type": "module",
1175
- "main": "index.ts",
1176
- "scripts": {
1177
- "dev": "versori dev",
1178
- "build": "versori build",
1179
- "deploy": "versori deploy",
1180
- "test": "jest",
1181
- "lint": "eslint src/**/*.ts"
1182
- },
1183
- "dependencies": {
1184
- "@fluentcommerce/fc-connect-sdk": "^0.1.39",
1185
- "@versori/run": "latest"
1186
- },
1187
- "devDependencies": {
1188
- "@types/node": "^20.0.0",
1189
- "typescript": "^5.0.0",
1190
- "jest": "^29.0.0",
1191
- "@types/jest": "^29.0.0",
1192
- "eslint": "^8.0.0"
1193
- }
1194
- }
1195
- ```
1196
-
1197
- ---
1198
-
1199
- ## Key Patterns Explained
1200
-
1201
- ### Pattern 1: RetailerId Validation Before setRetailerId()
1202
-
1203
- ```typescript
1204
- // ✅ CORRECT - Validate before use
1205
- const retailerId = payload.retailerId;
1206
- if (!retailerId) {
1207
- log.error('❌ [BACKGROUND] Missing retailerId in payload');
1208
- throw new Error('retailerId is required for GraphQL operations');
1209
- }
1210
-
1211
- const client = await createClient({ ...ctx, log });
1212
- await client.setRetailerId(retailerId);
1213
-
1214
- // ❌ WRONG - No validation
1215
- await client.setRetailerId(retailerId); // May be undefined!
1216
- ```
1217
-
1218
- **Why:** Missing retailerId causes 401 authentication errors with unclear messages.
1219
-
1220
- ### Pattern 2: SFTP uploadFile with Options Parameter
1221
-
1222
- ```typescript
1223
- // ✅ CORRECT - Include options parameter
1224
- await sftp.uploadFile(remoteFilePath, xmlBuffer, {
1225
- overwrite: true,
1226
- createDirectories: true,
1227
- });
1228
-
1229
- // ❌ WRONG - Missing options (works but not explicit)
1230
- await sftp.uploadFile(remoteFilePath, xmlBuffer);
1231
- ```
1232
-
1233
- **Why:** Explicit options make behavior clear and prevent production surprises.
1234
-
1235
- ### Pattern 3: SDK Error Type Handling
1236
-
1237
- ```typescript
1238
- // ✅ CORRECT - Handle SDK error types
1239
- import {
1240
- DataSourceError,
1241
- AuthenticationError,
1242
- GraphQLError,
1243
- } from '@fluentcommerce/fc-connect-sdk';
1244
-
1245
- catch (error: unknown) {
1246
- if (error instanceof GraphQLError) {
1247
- errorCategory = 'GRAPHQL';
1248
- recommendation = 'Review query syntax';
1249
- } else if (error instanceof AuthenticationError) {
1250
- errorCategory = 'AUTHENTICATION';
1251
- recommendation = 'Verify credentials';
1252
- } else if (error instanceof DataSourceError) {
1253
- errorCategory = 'DATA_SOURCE';
1254
- recommendation = 'Check SFTP config';
1255
- }
1256
- }
1257
-
1258
- // ❌ WRONG - Generic error handling
1259
- catch (error: unknown) {
1260
- const message = error instanceof Error ? error.message : String(error);
1261
- // No categorization or recommendations
1262
- }
1263
- ```
1264
-
1265
- **Why:** SDK errors include recommendations for resolution.
1266
-
1267
- ---
1268
-
1269
- ## Testing
1270
-
1271
- ### 1. Unit Tests
1272
-
1273
- ```typescript
1274
- // src/services/__tests__/fulfilment-query.test.ts
1275
- import { processFulfilmentExport } from '../fulfilment-query.service';
1276
-
1277
- describe('Fulfilment Query Service', () => {
1278
- test('should export fulfilment successfully', async () => {
1279
- const mockCtx = {
1280
- log: { info: jest.fn(), error: jest.fn() },
1281
- activation: { getVariable: jest.fn() },
1282
- };
1283
-
1284
- const payload = {
1285
- entityRef: 'FF-001',
1286
- entityType: 'FULFILMENT',
1287
- retailerId: '1',
1288
- };
1289
-
1290
- await expect(processFulfilmentExport(mockCtx, payload)).resolves.not.toThrow();
1291
- });
1292
-
1293
- test('should handle large fulfilment with pagination', async () => {
1294
- const mockCtx = {
1295
- log: { info: jest.fn(), error: jest.fn() },
1296
- activation: { getVariable: jest.fn() },
1297
- };
1298
-
1299
- const payload = {
1300
- entityRef: 'FF-LARGE-001', // Fulfilment with 150 items
1301
- entityType: 'FULFILMENT',
1302
- retailerId: '1',
1303
- };
1304
-
1305
- await expect(processFulfilmentExport(mockCtx, payload)).resolves.not.toThrow();
1306
-
1307
- // Verify pagination was logged
1308
- expect(mockCtx.log.info).toHaveBeenCalledWith(
1309
- expect.stringContaining('Fulfilment and items queried successfully'),
1310
- expect.objectContaining({
1311
- itemCount: 150,
1312
- paginationUsed: true,
1313
- })
1314
- );
1315
- });
1316
- });
1317
- ```
1318
-
1319
- ### 2. Integration Test
1320
-
1321
- ```bash
1322
- # Test webhook with valid signature
1323
- curl -X POST https://workspace.versori.run/rubix-fulfilment \
1324
- -H "Content-Type: application/json" \
1325
- -H "fluent-signature: <valid-signature>" \
1326
- -d '{
1327
- "entityType": "FULFILMENT",
1328
- "entityRef": "FF-001",
1329
- "retailerId": "1"
1330
- }'
1331
-
1332
- # Expected: 200 OK with { success: true, message: "..." }
1333
- ```
1334
-
1335
- ---
1336
-
1337
- ## Production Checklist
1338
-
1339
- - [ ] Configure `fluentPublicKey` activation variable
1340
- - [ ] Configure Fluent Commerce connection in Versori
1341
- - [ ] Configure `sftp_export_server` connection in Versori (Basic Auth with username/password)
1342
- - [ ] Set SFTP activation variables (host, port, remotePath)
1343
- - [ ] Verify SFTP remote path exists and is writable
1344
- - [ ] Create Rubix workflow with SendWebhook action (FULFILMENT events)
1345
- - [ ] Build Event payload with entityRef, entityType, retailerId
1346
- - [ ] Test webhook signature validation
1347
- - [ ] Test GraphQL query with real fulfilment ref
1348
- - [ ] **Test with large fulfilment (>100 items)** - Verify pagination works correctly
1349
- - [ ] Test XML generation with special characters
1350
- - [ ] Test SFTP upload and verify file on server
1351
- - [ ] Test error scenarios (invalid signature, missing retailerId, SFTP failure)
1352
- - [ ] Monitor response times (<100ms for validation)
1353
- - [ ] Set up alerts for webhook/export failures
1354
- - [ ] Document 3PL partner SFTP requirements
1355
- - [ ] Test SFTP connection cleanup (check logs for dispose)
1356
- - [ ] Verify pagination logs show correct item counts
1357
-
1358
- ---
1359
-
1360
- ## Troubleshooting Guide
1361
-
1362
- | Issue | Cause | Solution |
1363
- |-------|-------|----------|
1364
- | "Invalid webhook signature" | Wrong public key | Verify fluentPublicKey matches Fluent environment |
1365
- | "Missing retailerId" | Rubix payload incomplete | Add retailerId to Rubix Event payload builder |
1366
- | "Fulfilment not found" | Invalid ref or permissions | Verify fulfilment exists and user has query permissions |
1367
- | "SFTP upload failed" | Connection/credentials | Test SFTP manually, verify credentials in connection and path |
1368
- | "Failed to retrieve SFTP credentials" | Connection not configured | Ensure `sftp_export_server` connection exists with Basic Auth |
1369
- | "SFTP connection pool exhausted" | Missing dispose() | Verify dispose() is in finally block |
1370
- | "GraphQL query timeout" | Large dataset | Check pagination logs - pagination handles up to 1000 items |
1371
- | "Missing items in XML" | Fulfilment >1000 items | Increase maxPages limit or implement chunked export |
1372
-
1373
- ---
1374
-
1375
- ## Monitoring & Alerting
1376
-
1377
- ### Success Response
1378
-
1379
- ```json
1380
- {
1381
- "success": true,
1382
- "entityType": "FULFILMENT",
1383
- "fulfilmentRef": "FF-001",
1384
- "message": "Webhook validated and export started in background",
1385
- "timestamp": "2025-01-25T14:30:00.000Z",
1386
- "correlationId": "act_123",
1387
- "processingMode": "async"
1388
- }
1389
- ```
1390
-
1391
- ### Key Metrics
1392
-
1393
- ```typescript
1394
- const METRICS = {
1395
- signatureValidationMs: 45,
1396
- totalResponseTimeMs: 50,
1397
- graphqlQueryMs: 1200,
1398
- xmlGenerationMs: 50,
1399
- sftpUploadMs: 980,
1400
- totalBackgroundMs: 2230,
1401
- };
1402
- ```
1403
-
1404
- ---
1405
-
1406
- ## Related Documentation
1407
-
1408
- - [Order Attribute Update Template](./template-webhook-rubix-order-attribute-update.md) - For ORDER webhooks
1409
- - [Webhook Validation Guide](../../../../02-CORE-GUIDES/webhook-validation/)
1410
- - [Versori Platform Guide](../../../../04-REFERENCE/platforms/versori/)
1411
- - [SFTP Data Sources Guide](../../../../02-CORE-GUIDES/data-sources/)
1412
-
1413
- ---
1414
-
1415
- **Pattern**: Fulfilment webhook → GraphQL query → XML generation → SFTP upload
1416
- **✅ Production-Ready**: Comprehensive template with all critical fixes applied
1417
- **Key Learning**: Always validate retailerId, use proper SFTP options, handle SDK errors
1418
- **Critical**: SFTP dispose() in finally block, retailerId validation, fire-and-forget pattern
1
+ ---
2
+ template_id: tpl-webhook-rubix-fulfilment-export-inline
3
+ canonical_filename: template-webhook-rubix-fulfilment-to-sftp-xml-inline.md
4
+ version: 2.0.0
5
+ sdk_version: ^0.1.39
6
+ runtime: versori
7
+ direction: webhook
8
+ source: fluent-rubix-workflow
9
+ destination: sftp-xml
10
+ entity: fulfilment
11
+ format: xml
12
+ logging: versori
13
+ status: stable
14
+ pattern: inline-mapping
15
+ features:
16
+ - webhook-validation
17
+ - fire-and-forget
18
+ - background-processing
19
+ - xml-export
20
+ - sftp-integration
21
+ - graphql-queries
22
+ - inline-mapping
23
+ ---
24
+
25
+ # Template: Rubix Fulfilment Webhook → SFTP XML Export (Inline Mapping Pattern)
26
+
27
+ **Template Version:** 2.0.0
28
+ **SDK Version:** `^0.1.39` - `npm install @fluentcommerce/fc-connect-sdk@^0.1.39`
29
+ **Last Updated:** 2025-11-12
30
+ **Deployment Target:** Versori Platform
31
+ **Mapping Pattern:** 🔵 **INLINE MAPPING** (Simpler, faster, webhook-optimized)
32
+
33
+ > **📖 Pattern Selection Guide:**
34
+ > - **Use THIS template (Inline)** for: Simple webhooks, tightly-coupled 3PL schemas, fast debugging
35
+ > - **Use UniversalMapper version** for: Reusable configs, multi-environment deployments, complex transformations
36
+ > - **See also:** [template-webhook-rubix-fulfilment-to-sftp-xml-universal-mapper.md](./template-webhook-rubix-fulfilment-to-sftp-xml-universal-mapper.md)
37
+
38
+ **🆕 Version 2.0.0 - Production Ready:**
39
+ - ✅ **Fulfilment-specific template** - Focused on 3PL/WMS integration
40
+ - ✅ **Production-ready modular structure** - Separate workflows, services, types
41
+ - ✅ **GraphQL fulfilment queries** - Fetch fulfilment + line items + order details
42
+ - ✅ **Automatic pagination** - Handles fulfilments with 100+ items (up to 1000)
43
+ - ✅ **XML generation** - Safe XML with automatic escaping
44
+ - ✅ **SFTP upload** - Connection pooling with proper dispose()
45
+ - ✅ **Critical fixes applied** - retailerId validation, SFTP options parameter, pagination
46
+ - ✅ **Comprehensive documentation** - Testing, troubleshooting, monitoring
47
+
48
+ ---
49
+
50
+ ## Overview
51
+
52
+ Receive fulfilment webhooks from Rubix workflows, query fulfilment details, generate XML, and upload to 3PL/WMS SFTP server.
53
+
54
+ **Pattern:**
55
+ 1. Validate webhook signature (~10-50ms)
56
+ 2. Return HTTP 200 OK immediately (fast acknowledgment)
57
+ 3. Background: Query fulfilment details → Generate XML → Upload to SFTP (~2-5s)
58
+
59
+ **Business Use Case:**
60
+ - Rubix workflow sends webhook when fulfilment is created/updated
61
+ - Handler queries fulfilment details (items, order, addresses)
62
+ - Generates XML fulfillment notification for 3PL/WMS
63
+ - Uploads to partner SFTP server for warehouse processing
64
+
65
+ ---
66
+
67
+ ## STEP 1: Understand This Template
68
+
69
+ ### What This Template Does
70
+
71
+ **Core Functionality:**
72
+ - Receives FULFILMENT webhooks from Fluent Commerce Rubix workflows
73
+ - Validates webhook signature for security
74
+ - Returns fast HTTP 200 OK response (<100ms)
75
+ - Background: Queries fulfilment via GraphQL → Transforms to XML → Uploads to SFTP
76
+
77
+ **Key SDK Components:**
78
+ - `WebhookValidationService` - Signature validation with RSA/HMAC support
79
+ - `createClient()` - Universal client factory (auto-detects Versori context)
80
+ - `client.graphql()` - Query fulfilment details with automatic pagination
81
+ - `XMLBuilder` - Safe XML generation with automatic escaping
82
+ - `SftpDataSource` - SFTP operations with connection pooling
83
+ - `ctx.credentials().getAccessToken()` - Retrieve SFTP credentials from Versori connection vault
84
+ - Native Versori `log` - Structured logging from context
85
+
86
+ **Pagination Support:**
87
+ - Automatically handles fulfilments with 100+ line items
88
+ - Uses two-query pattern: fulfilment details + paginated items
89
+ - SDK auto-pagination: `pagination: { maxPages: 10 }` supports up to 1000 items
90
+ - Logs pagination usage for monitoring
91
+
92
+ **Critical Patterns:**
93
+ - **Sync + Fire-and-Forget**: Fast validation, background processing
94
+ - **Signature Validation**: Always validate `fluent-signature` or `flex.signature` headers
95
+ - **Background Promises**: Use `.then().catch()` for error handling
96
+ - **SFTP Credentials**: Retrieve from Versori connection vault (not activation variables)
97
+ - **SFTP Cleanup**: Always call `dispose()` in finally blocks
98
+ - **RetailerId Validation**: Check before `setRetailerId()` to prevent 401 errors
99
+
100
+ ### When to Use This Template
101
+
102
+ ✅ **USE THIS TEMPLATE FOR:**
103
+ - Fulfilment created/updated webhooks from Rubix workflows
104
+ - Export fulfilment details to 3PL/WMS via SFTP
105
+ - Need XML format for warehouse management systems
106
+ - Require signature validation for security
107
+ - Need fast webhook acknowledgment + async processing
108
+
109
+ ❌ **DON'T USE FOR:**
110
+ - Order webhooks (use order attribute update template)
111
+ - Inventory webhooks (use inventory templates)
112
+ - CSV/JSON exports (use format-specific templates)
113
+ - Synchronous processing required (use standard http workflow)
114
+
115
+ ### Business Use Cases
116
+
117
+ **Use Case: 3PL Warehouse Fulfillment Notification**
118
+ - Rubix workflow sends webhook when fulfilment moves to "ALLOCATED" status
119
+ - Handler queries fulfilment details (items, quantities, order info)
120
+ - Generates XML fulfillment order for warehouse system
121
+ - Uploads to 3PL SFTP server for pick/pack/ship processing
122
+ - 3PL system imports XML and creates warehouse tasks
123
+
124
+ ---
125
+
126
+ ## STEP 2: Implementation Prompt for Claude Code
127
+
128
+ **Copy this prompt and send to Claude Code to generate the complete implementation:**
129
+
130
+ ```
131
+ Create a Versori webhook handler for Fluent Commerce Rubix FULFILMENT events with signature validation, GraphQL queries, XML generation, and SFTP upload.
132
+
133
+ REQUIREMENTS:
134
+ 1. Runtime: Versori Platform (HTTP webhook)
135
+ 2. Source: Rubix SendWebhook action (FULFILMENT entity type only)
136
+ 3. Destination: SFTP XML export to 3PL/WMS partner
137
+ 4. Format: XML with fulfilment details, line items, order info
138
+ 5. Entity: FULFILMENT
139
+
140
+ KEY FEATURES:
141
+ - Webhook signature validation using WebhookValidationService
142
+ - Sync mode + fire-and-forget pattern for fast response
143
+ - Background processing: GraphQL query → Inline XML mapping → XML generation → SFTP upload
144
+ - **Automatic pagination** - Handles fulfilments with 100+ items (up to 1000 items)
145
+ - Two-query pattern: Fulfilment details + paginated items query
146
+ - **Inline XML mapping** - Manual object construction (simple, no config files)
147
+ - **XMLBuilder** - Safe XML generation with automatic escaping
148
+ - Modular architecture (workflows/, services/, types/)
149
+ - Native Versori logging (no LoggingService)
150
+ - SFTP cleanup with dispose() in finally blocks
151
+ - Comprehensive error handling with SDK error types
152
+ - RetailerId validation before setRetailerId()
153
+
154
+ CRITICAL REQUIREMENTS:
155
+ 1. Webhook Mode: response: { mode: 'sync' }
156
+ 2. Signature Validation: WebhookValidationService with strictValidation: true
157
+ 3. RetailerId Validation: Check exists before client.setRetailerId()
158
+ 4. Background Processing: Fire-and-forget pattern (no await on background promise)
159
+ 5. GraphQL Queries: Two separate queries (fulfilment + items with pagination)
160
+ 6. Pagination: Use SDK automatic pagination with maxPages: 10, first: 100
161
+ 7. **Inline Mapping**: Manual object construction for XML structure (no external config)
162
+ 8. XML Generation: Use XMLBuilder with automatic escaping
163
+ 9. SFTP Upload: Include options parameter { overwrite: true, createDirectories: true }
164
+ 10. SFTP Cleanup: Always dispose() in finally block
165
+ 11. Error Handling: Import and handle DataSourceError, AuthenticationError, GraphQLError
166
+ 12. Type Safety: Use Logger, VersoriContext types (not any)
167
+
168
+ SDK METHODS TO USE:
169
+ - import { Buffer } from 'node:buffer' (CRITICAL for Versori/Deno)
170
+ - createClient({ ...ctx, log })
171
+ - await client.setRetailerId(retailerId) (with validation first!)
172
+ - new WebhookValidationService({ strictValidation: true }, log)
173
+ - await validator.validateWebhook(rawBody, headers, publicKey)
174
+ - await client.graphql({ query, variables, pagination: { maxPages: 10 } })
175
+ - Manual object construction for XML structure (inline mapping)
176
+ - new XMLBuilder({ prettyPrint: true, xmlDeclaration: true, encoding: 'UTF-8' })
177
+ - xmlBuilder.build(xmlData, 'FulfilmentExport')
178
+ - await ctx.credentials().getAccessToken('sftp_export_server') - Retrieve SFTP credentials from connection vault
179
+ - Buffer.from(accessToken, 'base64').toString('utf-8') - Decode Basic Auth credentials
180
+ - new SftpDataSource(config, log) - config includes connectionId: 'sftp_export_server'
181
+ - await sftp.uploadFile(remotePath, buffer, { overwrite: true, createDirectories: true })
182
+ - await sftp.dispose() (CRITICAL in finally block)
183
+
184
+ FORBIDDEN PATTERNS:
185
+ - ❌ LoggingService (use native log from context)
186
+ - ❌ await on background processing (use fire-and-forget)
187
+ - ❌ Missing dispose() for SFTP
188
+ - ❌ Missing options parameter in uploadFile()
189
+ - ❌ Missing retailerId validation before setRetailerId()
190
+ - ❌ Storing SFTP credentials in activation variables (use Versori connection vault)
191
+ - ❌ Using 'any' type (use Logger, VersoriContext from SDK)
192
+ - ❌ Direct FluentClient instantiation (use createClient factory)
193
+ - ❌ Generic error handling (use SDK error types)
194
+
195
+ GRAPHQL QUERY STRUCTURE:
196
+
197
+ **Single Query with Nested Items (Schema-Validated)**
198
+ ```graphql
199
+ query GetFulfilment($id: ID!, $first: Int!, $after: String) {
200
+ fulfilment(id: $id) {
201
+ id
202
+ ref
203
+ status
204
+ deliveryType
205
+ order {
206
+ id
207
+ ref
208
+ customer { firstName, lastName, email }
209
+ }
210
+ toAddress {
211
+ name, street, street2, city, state, postcode, country
212
+ }
213
+ fromAddress {
214
+ name, street, street2, city, state, postcode, country
215
+ }
216
+ items(first: $first, after: $after) {
217
+ edges {
218
+ node {
219
+ id
220
+ ref
221
+ requestedQuantity
222
+ filledQuantity
223
+ rejectedQuantity
224
+ orderItem {
225
+ id
226
+ ref
227
+ productRef
228
+ product { name }
229
+ }
230
+ }
231
+ cursor
232
+ }
233
+ pageInfo {
234
+ hasNextPage
235
+ }
236
+ }
237
+ createdOn
238
+ updatedOn
239
+ }
240
+ }
241
+ ```
242
+
243
+ **Why Single Query?**
244
+ - Items are nested under the fulfilment type in Fluent Commerce schema
245
+ - Single query with `connectionPath: 'fulfilment.items'` for SDK pagination
246
+ - SDK automatically handles pagination with `pagination: { maxPages: 10 }` config
247
+ - More efficient than two separate queries (reduces GraphQL roundtrips)
248
+
249
+ XML OUTPUT STRUCTURE:
250
+ <FulfilmentExport>
251
+ <Fulfilment ref="FF-001" status="ALLOCATED">
252
+ <OrderRef>ORD-123</OrderRef>
253
+ <DeliveryType>STANDARD</DeliveryType>
254
+ <Customer>
255
+ <FirstName>John</FirstName>
256
+ <LastName>Smith</LastName>
257
+ <Email>john@example.com</Email>
258
+ </Customer>
259
+ <ToAddress>
260
+ <Name>John Smith</Name>
261
+ <Street>123 Main St</Street>
262
+ <Street2>Apt 4B</Street2>
263
+ <City>New York</City>
264
+ <State>NY</State>
265
+ <Postcode>10001</Postcode>
266
+ <Country>US</Country>
267
+ </ToAddress>
268
+ <FromAddress>
269
+ <Name>Warehouse</Name>
270
+ <Street>456 Warehouse St</Street>
271
+ <City>Chicago</City>
272
+ <State>IL</State>
273
+ <Postcode>60601</Postcode>
274
+ <Country>US</Country>
275
+ </FromAddress>
276
+ <Items>
277
+ <Item ref="FFI-001">
278
+ <ProductRef>SKU-001</ProductRef>
279
+ <ProductName>Widget</ProductName>
280
+ <RequestedQuantity>2</RequestedQuantity>
281
+ <FilledQuantity>2</FilledQuantity>
282
+ <RejectedQuantity>0</RejectedQuantity>
283
+ </Item>
284
+ </Items>
285
+ <CreatedOn>2025-01-25T10:00:00Z</CreatedOn>
286
+ <UpdatedOn>2025-01-25T11:00:00Z</UpdatedOn>
287
+ </Fulfilment>
288
+ </FulfilmentExport>
289
+
290
+ GENERATE:
291
+ 1. package.json with dependencies
292
+ 2. index.ts (entry point - exports workflow)
293
+ 3. src/workflows/webhook/fulfilment-export-handler.ts (webhook entry)
294
+ 4. src/services/fulfilment-query.service.ts (GraphQL queries)
295
+ 5. src/services/xml-export.service.ts (Inline XML mapping + XMLBuilder + SFTP upload)
296
+ 6. src/types/fulfilment.types.ts (TypeScript interfaces)
297
+ 7. readme.md with setup instructions
298
+
299
+ Ensure all code is production-ready with proper error handling, signature validation, SFTP cleanup, inline XML mapping, and type safety.
300
+ ```
301
+
302
+ ---
303
+
304
+ ## STEP 3: Detailed Flow Documentation
305
+
306
+ ### Complete Processing Flow
307
+
308
+ ```
309
+ ┌─────────────────────────────────────────────────────────────┐
310
+ │ 1. RUBIX WEBHOOK RECEIVED │
311
+ │ POST https://{workspace}.versori.run/rubix-fulfilment │
312
+ │ Headers: fluent-signature │
313
+ │ Body: { entityRef: "FF-001", entityType: "FULFILMENT" } │
314
+ └────────────────────┬────────────────────────────────────────┘
315
+
316
+
317
+ ┌─────────────────────────────────────────────────────────────┐
318
+ │ 2. SIGNATURE VALIDATION (Synchronous, ~10-50ms) │
319
+ │ - Extract rawBody and headers │
320
+ │ - Get fluentPublicKey from activation │
321
+ │ - WebhookValidationService.validateWebhook() │
322
+ │ - Return 400 if invalid │
323
+ └────────────────────┬────────────────────────────────────────┘
324
+
325
+
326
+ ┌─────────────────────────────────────────────────────────────┐
327
+ │ 3. PAYLOAD VALIDATION (Synchronous, ~5ms) │
328
+ │ - Check entityRef exists │
329
+ │ - Check entityType === 'FULFILMENT' │
330
+ │ - Check retailerId exists │
331
+ │ - Return 400 if missing required fields │
332
+ └────────────────────┬────────────────────────────────────────┘
333
+
334
+
335
+ ┌─────────────────────────────────────────────────────────────┐
336
+ │ 4. HTTP 200 OK RESPONSE (Total: ~50ms) │
337
+ │ - Return success immediately │
338
+ │ - Background promise continues (fire-and-forget) │
339
+ └────────────────────┬────────────────────────────────────────┘
340
+
341
+ ▼ (Background - doesn't block response)
342
+ ┌─────────────────────────────────────────────────────────────┐
343
+ │ 5. BACKGROUND PROCESSING (~2-5 seconds) │
344
+ │ ┌─────────────────────────────────────────────────────┐ │
345
+ │ │ 5a. Initialize Fluent Client (~100ms) │ │
346
+ │ │ - createClient({ ...ctx, log }) │ │
347
+ │ │ - Validate retailerId exists │ │
348
+ │ │ - client.setRetailerId(retailerId) │ │
349
+ │ └─────────────────────────────────────────────────────┘ │
350
+ │ ┌─────────────────────────────────────────────────────┐ │
351
+ │ │ 5b. Query Fulfilment Details (~500-1500ms) │ │
352
+ │ │ - GraphQL query with nested fields │ │
353
+ │ │ - Fulfilment + items + order + addresses │ │
354
+ │ │ - Handle GraphQLError if query fails │ │
355
+ │ └─────────────────────────────────────────────────────┘ │
356
+ │ ┌─────────────────────────────────────────────────────┐ │
357
+ │ │ 5c. Generate XML (~50ms) │ │
358
+ │ │ - Inline XML structure construction │ │
359
+ │ │ - XMLBuilder handles escaping automatically │ │
360
+ │ │ - Create Buffer from XML string │ │
361
+ │ └─────────────────────────────────────────────────────┘ │
362
+ │ ┌─────────────────────────────────────────────────────┐ │
363
+ │ │ 5d. Upload to SFTP (~500-2000ms) │ │
364
+ │ │ - Initialize SftpDataSource │ │
365
+ │ │ - Upload with options parameter │ │
366
+ │ │ - Handle DataSourceError if upload fails │ │
367
+ │ │ - ALWAYS dispose() in finally block │ │
368
+ │ └─────────────────────────────────────────────────────┘ │
369
+ │ ┌─────────────────────────────────────────────────────┐ │
370
+ │ │ 5e. Log Completion │ │
371
+ │ │ - Success: Log fulfilment ref and duration │ │
372
+ │ │ - Failure: Log error with category │ │
373
+ │ └─────────────────────────────────────────────────────┘ │
374
+ └─────────────────────────────────────────────────────────────┘
375
+ ```
376
+
377
+ ### Response Timing
378
+
379
+ | Stage | Timing | Blocking |
380
+ |-------|--------|----------|
381
+ | **Signature Validation** | ~10-50ms | ✅ Yes (blocks response) |
382
+ | **Payload Validation** | ~5ms | ✅ Yes (blocks response) |
383
+ | **HTTP 200 Response** | ~50-100ms | ✅ Fast acknowledgment |
384
+ | **GraphQL Query** | ~500-1500ms | ❌ No (background) |
385
+ | **XML Generation** | ~50ms | ❌ No (background) |
386
+ | **SFTP Upload** | ~500-2000ms | ❌ No (background) |
387
+ | **Total Background** | ~2000-5000ms | ❌ Fire-and-forget |
388
+
389
+ ---
390
+
391
+ ## STEP 4: Production Modular Structure
392
+
393
+ ### Complete Project Structure
394
+
395
+ ```
396
+ rubix-fulfilment-export/
397
+ ├── package.json # Dependencies and Versori config
398
+ ├── tsconfig.json # TypeScript configuration
399
+ ├── readme.md # Setup and deployment instructions
400
+ ├── index.ts # Entry point - exports workflow
401
+ └── src/
402
+ ├── workflows/
403
+ │ └── webhook/
404
+ │ └── fulfilment-export-handler.ts # Webhook entry point
405
+
406
+ ├── services/
407
+ │ ├── fulfilment-query.service.ts # GraphQL queries
408
+ │ └── xml-export.service.ts # Inline XML mapping + XMLBuilder + SFTP upload
409
+
410
+ └── types/
411
+ └── fulfilment.types.ts # TypeScript interfaces
412
+ ```
413
+
414
+ **Why This Structure?**
415
+ - ✅ **Clear separation**: Webhook handlers vs business logic
416
+ - ✅ **Reusable services**: Query and export logic can be unit tested
417
+ - ✅ **Simple inline mapping**: XML structure defined directly in code (no config files)
418
+ - ✅ **Type safety**: TypeScript interfaces for better IDE support
419
+ - ✅ **Scalable**: Easy to add more fulfilment webhooks
420
+ - ✅ **Testable**: Services can be mocked and tested independently
421
+ - ✅ **Fast debugging**: XML structure visible directly in code
422
+
423
+ ---
424
+
425
+ ## SDK Imports (Verified - Versori Optimized)
426
+
427
+ ```typescript
428
+ // CRITICAL: Buffer import required for Versori/Deno runtime
429
+ import { Buffer } from 'node:buffer';
430
+
431
+ // FC Connect SDK imports
432
+ import {
433
+ createClient,
434
+ WebhookValidationService,
435
+ XMLBuilder,
436
+ SftpDataSource,
437
+ DataSourceError,
438
+ AuthenticationError,
439
+ GraphQLError,
440
+ type Logger,
441
+ type VersoriContext,
442
+ } from '@fluentcommerce/fc-connect-sdk';
443
+
444
+ // Versori platform imports
445
+ import { webhook } from '@versori/run';
446
+ import type { Context } from '@versori/run';
447
+ ```
448
+
449
+ ---
450
+
451
+ ## Configuration
452
+
453
+ ### Activation Variables
454
+
455
+ ```json
456
+ {
457
+ "fluentPublicKey": "-----BEGIN PUBLIC KEY-----...-----END PUBLIC KEY-----",
458
+ "sftpHost": "sftp.3pl-partner.com",
459
+ "sftpPort": 22,
460
+ "sftpRemotePath": "/incoming/fulfilments/"
461
+ }
462
+ ```
463
+
464
+ > **Important:** `sftpUsername` and `sftpPassword` are **NOT** stored in activation variables. They are securely retrieved from the `sftp_export_server` connection vault at runtime. See the SFTP Credential Management section below for details.
465
+
466
+ ### Connections
467
+
468
+ | Connection | Description | Required |
469
+ |------------|-------------|----------|
470
+ | `fluent_commerce` | OAuth2 connection to Fluent Commerce | Yes |
471
+ | `sftp_export_server` | Basic Auth connection for SFTP credentials (username/password) | Yes |
472
+
473
+ ## SFTP Credential Management
474
+
475
+ Fetch credentials securely from Versori connection vault using `ctx.credentials().getAccessToken()`:
476
+
477
+ **Benefits:**
478
+ - ✅ Credentials stored securely in Versori vault
479
+ - ✅ Centralized management - update in one place
480
+ - ✅ Access control enforced by platform
481
+ - ✅ No credentials in activation variables
482
+ - ✅ Explicit error handling with validation
483
+
484
+ ### Setup Steps
485
+
486
+ 1. In Versori Dashboard → Connections → Add Connection
487
+ 2. Name: `sftp_export_server`
488
+ 3. Type: Basic Auth
489
+ 4. Enter SFTP username and password
490
+ 5. Save connection
491
+ 6. Reference in code: `ctx.credentials().getAccessToken('sftp_export_server')`
492
+
493
+ ---
494
+
495
+ ## Complete Working Code
496
+
497
+ ### 1. Entry Point (index.ts)
498
+
499
+ ```typescript
500
+ /**
501
+ * Entry point - Export webhook workflow for Versori platform
502
+ */
503
+
504
+ export { rubixFulfilmentExportHandler } from './src/workflows/webhook/fulfilment-export-handler';
505
+ ```
506
+
507
+ ### 2. Webhook Handler (src/workflows/webhook/fulfilment-export-handler.ts)
508
+
509
+ ```typescript
510
+ /**
511
+ * Rubix Fulfilment Webhook Handler → SFTP XML Export
512
+ *
513
+ * Direction: Fluent Rubix Workflow (FULFILMENT) → Versori → GraphQL → XML → SFTP
514
+ */
515
+
516
+ import { Buffer } from 'node:buffer';
517
+ import { webhook } from '@versori/run';
518
+ import type { Context } from '@versori/run';
519
+ import {
520
+ WebhookValidationService,
521
+ type Logger,
522
+ } from '@fluentcommerce/fc-connect-sdk';
523
+ import { processFulfilmentExport } from '../../services/fulfilment-query.service';
524
+
525
+ export const rubixFulfilmentExportHandler = webhook('rubix-fulfilment', {
526
+ response: { mode: 'sync' }, // ✅ Sync mode: response sent when handler returns
527
+ }, async (ctx: Context<any>) => {
528
+ const { log, activation } = ctx;
529
+
530
+ log.info('🚀 [WEBHOOK] Received Rubix fulfilment webhook', {
531
+ timestamp: new Date().toISOString(),
532
+ correlationId: activation?.id,
533
+ });
534
+
535
+ // ========================================
536
+ // STEP 1: VALIDATE SIGNATURE (Synchronous)
537
+ // ========================================
538
+
539
+ const publicKey = activation.getVariable('fluentPublicKey');
540
+ if (!publicKey) {
541
+ log.error('❌ [WEBHOOK] Missing fluentPublicKey configuration');
542
+ return {
543
+ status: 500,
544
+ body: {
545
+ success: false,
546
+ error: 'Missing fluentPublicKey configuration',
547
+ recommendation: 'Configure fluentPublicKey in activation variables',
548
+ },
549
+ };
550
+ }
551
+
552
+ // Extract raw body (Versori provides parsed data in ctx.data)
553
+ const rawBody = typeof ctx.data === 'string' ? ctx.data : JSON.stringify(ctx.data);
554
+
555
+ // Extract headers from request (ctx.request() is a function call)
556
+ const req = ctx.request?.() || {};
557
+ const headersObj = req.headers || {};
558
+ const headers = headersObj instanceof Headers
559
+ ? Object.fromEntries(headersObj.entries())
560
+ : headersObj;
561
+
562
+ log.info('🔍 [WEBHOOK] Validating webhook signature');
563
+
564
+ const validator = new WebhookValidationService({ strictValidation: true }, log as Logger);
565
+ const result = await validator.validateWebhook(rawBody, headers, publicKey);
566
+
567
+ if (!result.isValid) {
568
+ log.error('❌ [WEBHOOK] Invalid webhook signature', {
569
+ error: result.error,
570
+ algorithm: result.algorithm,
571
+ });
572
+ return {
573
+ status: 401,
574
+ body: {
575
+ success: false,
576
+ error: 'Invalid webhook signature',
577
+ recommendation: 'Verify fluentPublicKey matches Fluent environment',
578
+ },
579
+ };
580
+ }
581
+
582
+ log.info('✅ [WEBHOOK] Signature validated successfully', {
583
+ algorithm: result.algorithm,
584
+ });
585
+
586
+ // ========================================
587
+ // STEP 2: VALIDATE PAYLOAD (Synchronous)
588
+ // ========================================
589
+
590
+ const payload = typeof ctx.data === 'string' ? JSON.parse(ctx.data) : ctx.data;
591
+ const { entityRef, entityType, retailerId } = payload;
592
+
593
+ if (!entityRef) {
594
+ log.error('❌ [WEBHOOK] Missing entityRef in payload', { payload });
595
+ return {
596
+ status: 400,
597
+ body: {
598
+ success: false,
599
+ error: 'Missing entityRef in payload',
600
+ recommendation: 'Ensure Rubix SendWebhook includes fulfilment ref',
601
+ },
602
+ };
603
+ }
604
+
605
+ if (entityType !== 'FULFILMENT') {
606
+ log.error('❌ [WEBHOOK] Invalid entity type', { entityType, expected: 'FULFILMENT' });
607
+ return {
608
+ status: 400,
609
+ body: {
610
+ success: false,
611
+ error: `Invalid entity type: ${entityType}. Expected: FULFILMENT`,
612
+ recommendation: 'Use order-attribute-update template for ORDER webhooks',
613
+ },
614
+ };
615
+ }
616
+
617
+ if (!retailerId) {
618
+ log.error('❌ [WEBHOOK] Missing retailerId in payload', { payload });
619
+ return {
620
+ status: 400,
621
+ body: {
622
+ success: false,
623
+ error: 'Missing retailerId in payload',
624
+ recommendation: 'Ensure Rubix SendWebhook includes retailerId',
625
+ },
626
+ };
627
+ }
628
+
629
+ log.info('✅ [WEBHOOK] Validation passed, starting background processing', {
630
+ entityRef,
631
+ entityType,
632
+ retailerId,
633
+ });
634
+
635
+ // ========================================
636
+ // STEP 3: FIRE-AND-FORGET BACKGROUND PROCESSING
637
+ // ========================================
638
+
639
+ // ✅ Fire-and-forget: Start background processing WITHOUT await
640
+ // The promise continues execution after we return the response
641
+ processFulfilmentExport(ctx, payload)
642
+ .then(() => {
643
+ log.info('✅ [BACKGROUND] Fulfilment exported successfully', {
644
+ fulfilmentRef: entityRef,
645
+ });
646
+ })
647
+ .catch((error: unknown) => {
648
+ const errorMessage = error instanceof Error ? error.message : String(error);
649
+ log.error('❌ [BACKGROUND] Fulfilment export failed', {
650
+ fulfilmentRef: entityRef,
651
+ error: errorMessage,
652
+ stack: error instanceof Error ? error.stack : undefined,
653
+ errorType: error instanceof Error ? error.constructor.name : typeof error,
654
+ });
655
+ });
656
+
657
+ // Return immediately (response sent with this return value)
658
+ return {
659
+ status: 200,
660
+ body: {
661
+ success: true,
662
+ entityType,
663
+ fulfilmentRef: entityRef,
664
+ message: 'Webhook validated and export started in background',
665
+ timestamp: new Date().toISOString(),
666
+ correlationId: activation?.id,
667
+ },
668
+ };
669
+ });
670
+ ```
671
+
672
+ ### 3. Fulfilment Query Service (src/services/fulfilment-query.service.ts)
673
+
674
+ ```typescript
675
+ /**
676
+ * Fulfilment Query Service
677
+ *
678
+ * Handles GraphQL queries for fulfilment details and orchestrates XML export
679
+ */
680
+
681
+ import {
682
+ createClient,
683
+ DataSourceError,
684
+ AuthenticationError,
685
+ GraphQLError,
686
+ type Logger,
687
+ type VersoriContext,
688
+ } from '@fluentcommerce/fc-connect-sdk';
689
+ import { exportFulfilmentToSFTP } from './xml-export.service';
690
+ import type { RubixFulfilmentPayload, FulfilmentData } from '../types/fulfilment.types';
691
+
692
+ // Single query with nested items (schema-validated structure)
693
+ const FULFILMENT_QUERY = `
694
+ query GetFulfilment($id: ID!, $first: Int!, $after: String) {
695
+ fulfilment(id: $id) {
696
+ id
697
+ ref
698
+ status
699
+ deliveryType
700
+ order {
701
+ id
702
+ ref
703
+ customer {
704
+ firstName
705
+ lastName
706
+ email
707
+ }
708
+ }
709
+ toAddress {
710
+ name
711
+ street
712
+ street2
713
+ city
714
+ state
715
+ postcode
716
+ country
717
+ }
718
+ fromAddress {
719
+ name
720
+ street
721
+ street2
722
+ city
723
+ state
724
+ postcode
725
+ country
726
+ }
727
+ items(first: $first, after: $after) {
728
+ edges {
729
+ node {
730
+ id
731
+ ref
732
+ requestedQuantity
733
+ filledQuantity
734
+ rejectedQuantity
735
+ orderItem {
736
+ id
737
+ ref
738
+ productRef
739
+ product {
740
+ name
741
+ }
742
+ }
743
+ }
744
+ cursor
745
+ }
746
+ pageInfo {
747
+ hasNextPage
748
+ }
749
+ }
750
+ createdOn
751
+ updatedOn
752
+ }
753
+ }
754
+ `;
755
+
756
+ export async function processFulfilmentExport(
757
+ ctx: VersoriContext,
758
+ payload: RubixFulfilmentPayload
759
+ ): Promise<void> {
760
+ const log = ctx.log as Logger;
761
+ const { entityRef, retailerId } = payload;
762
+
763
+ const processingStartTime = Date.now();
764
+
765
+ log.info('🔄 [BACKGROUND] Starting fulfilment export', {
766
+ timestamp: new Date().toISOString(),
767
+ fulfilmentRef: entityRef,
768
+ });
769
+
770
+ try {
771
+ // ========================================
772
+ // STEP 1: VALIDATE RETAILER ID
773
+ // ========================================
774
+
775
+ if (!retailerId) {
776
+ log.error('❌ [BACKGROUND] Missing retailerId in payload', {
777
+ fulfilmentRef: entityRef,
778
+ });
779
+ throw new Error('retailerId is required for GraphQL operations');
780
+ }
781
+
782
+ // ========================================
783
+ // STEP 2: INITIALIZE FLUENT CLIENT
784
+ // ========================================
785
+
786
+ const client = await createClient({ ...ctx, log });
787
+ await client.setRetailerId(retailerId);
788
+
789
+ // ========================================
790
+ // STEP 3: QUERY FULFILMENT WITH NESTED ITEMS
791
+ // ========================================
792
+
793
+ log.info('🔍 [BACKGROUND] Querying fulfilment with items', { fulfilmentRef: entityRef });
794
+
795
+ const result = await client.graphql({
796
+ query: FULFILMENT_QUERY,
797
+ variables: {
798
+ id: entityRef, // ✅ Use 'id' parameter (schema-validated)
799
+ first: 100,
800
+ },
801
+ pagination: {
802
+ connectionPath: 'fulfilment.items', // ✅ Nested connection pagination
803
+ maxPages: 10, // Handles up to 1000 items (100 per page × 10 pages)
804
+ },
805
+ });
806
+
807
+ const fulfilmentData = result.data?.fulfilment as FulfilmentData | null;
808
+
809
+ if (!fulfilmentData) {
810
+ log.error('❌ [BACKGROUND] Fulfilment not found', { fulfilmentRef: entityRef });
811
+ throw new Error(`Fulfilment not found: ${entityRef}`);
812
+ }
813
+
814
+ const itemCount = fulfilmentData.items?.edges?.length || 0;
815
+
816
+ log.info('✅ [BACKGROUND] Fulfilment and items queried successfully', {
817
+ fulfilmentRef: fulfilmentData.ref,
818
+ status: fulfilmentData.status,
819
+ itemCount,
820
+ orderRef: fulfilmentData.order?.ref,
821
+ paginationUsed: result.metadata?.totalPages > 1,
822
+ });
823
+
824
+ // ========================================
825
+ // STEP 5: EXPORT TO SFTP
826
+ // ========================================
827
+
828
+ await exportFulfilmentToSFTP(ctx, completeFullfilmentData, log);
829
+
830
+ const duration = Date.now() - processingStartTime;
831
+ log.info('✅ [BACKGROUND] Fulfilment export completed', {
832
+ fulfilmentRef: entityRef,
833
+ duration: `${duration}ms`,
834
+ });
835
+ } catch (error: unknown) {
836
+ let errorMessage = 'Unknown error';
837
+ let recommendation: string | undefined;
838
+ let errorCategory = 'UNKNOWN';
839
+
840
+ if (error instanceof GraphQLError) {
841
+ errorMessage = error.message;
842
+ recommendation = 'Review GraphQL query syntax and field permissions';
843
+ errorCategory = 'GRAPHQL';
844
+ } else if (error instanceof AuthenticationError) {
845
+ errorMessage = error.message;
846
+ recommendation = 'Verify Fluent Commerce credentials and retailerId';
847
+ errorCategory = 'AUTHENTICATION';
848
+ } else if (error instanceof DataSourceError) {
849
+ errorMessage = error.message;
850
+ recommendation = 'Check SFTP configuration and connectivity';
851
+ errorCategory = 'DATA_SOURCE';
852
+ } else if (error instanceof Error) {
853
+ errorMessage = error.message;
854
+ } else {
855
+ errorMessage = String(error);
856
+ }
857
+
858
+ log.error('❌ [BACKGROUND] Fulfilment export failed', {
859
+ fulfilmentRef: entityRef,
860
+ error: errorMessage,
861
+ errorCategory,
862
+ recommendation,
863
+ stack: error instanceof Error ? error.stack : undefined,
864
+ errorType: error instanceof Error ? error.constructor.name : typeof error,
865
+ });
866
+
867
+ throw error;
868
+ }
869
+ }
870
+ ```
871
+
872
+ ### 4. XML Export Service (src/services/xml-export.service.ts)
873
+
874
+ ```typescript
875
+ /**
876
+ * XML Export Service
877
+ *
878
+ * Handles XML generation and SFTP upload for fulfilment exports
879
+ * Uses inline mapping (manual object construction) for XML structure
880
+ */
881
+
882
+ import { Buffer } from 'node:buffer';
883
+ import {
884
+ XMLBuilder,
885
+ SftpDataSource,
886
+ type Logger,
887
+ type VersoriContext,
888
+ } from '@fluentcommerce/fc-connect-sdk';
889
+ import type { FulfilmentData } from '../types/fulfilment.types';
890
+
891
+ export async function exportFulfilmentToSFTP(
892
+ ctx: VersoriContext,
893
+ fulfilmentData: FulfilmentData,
894
+ log: Logger
895
+ ): Promise<void> {
896
+ const { activation } = ctx;
897
+
898
+ log.info('📝 [BACKGROUND] Generating XML for fulfilment', {
899
+ fulfilmentRef: fulfilmentData.ref,
900
+ });
901
+
902
+ // ========================================
903
+ // STEP 1: BUILD XML STRUCTURE (INLINE MAPPING)
904
+ // ========================================
905
+
906
+ const xmlBuilder = new XMLBuilder({
907
+ prettyPrint: true,
908
+ xmlDeclaration: true,
909
+ encoding: 'UTF-8',
910
+ });
911
+
912
+ // Inline XML structure construction
913
+ const xmlData = {
914
+ Fulfilment: {
915
+ '@ref': fulfilmentData.ref,
916
+ '@status': fulfilmentData.status,
917
+ OrderRef: fulfilmentData.order?.ref || '',
918
+ DeliveryType: fulfilmentData.deliveryType || '',
919
+ Customer: fulfilmentData.order?.customer
920
+ ? {
921
+ FirstName: fulfilmentData.order.customer.firstName || '',
922
+ LastName: fulfilmentData.order.customer.lastName || '',
923
+ Email: fulfilmentData.order.customer.email || '',
924
+ }
925
+ : {},
926
+ ToAddress: fulfilmentData.toAddress
927
+ ? {
928
+ Name: fulfilmentData.toAddress.name || '',
929
+ Street: fulfilmentData.toAddress.street || '',
930
+ Street2: fulfilmentData.toAddress.street2 || '',
931
+ City: fulfilmentData.toAddress.city || '',
932
+ State: fulfilmentData.toAddress.state || '',
933
+ Postcode: fulfilmentData.toAddress.postcode || '',
934
+ Country: fulfilmentData.toAddress.country || '',
935
+ }
936
+ : {},
937
+ FromAddress: fulfilmentData.fromAddress
938
+ ? {
939
+ Name: fulfilmentData.fromAddress.name || '',
940
+ Street: fulfilmentData.fromAddress.street || '',
941
+ Street2: fulfilmentData.fromAddress.street2 || '',
942
+ City: fulfilmentData.fromAddress.city || '',
943
+ State: fulfilmentData.fromAddress.state || '',
944
+ Postcode: fulfilmentData.fromAddress.postcode || '',
945
+ Country: fulfilmentData.fromAddress.country || '',
946
+ }
947
+ : {},
948
+ Items: {
949
+ Item:
950
+ fulfilmentData.items?.edges?.map(edge => ({
951
+ '@ref': edge.node.ref,
952
+ ProductRef: edge.node.orderItem?.productRef || '',
953
+ ProductName: edge.node.orderItem?.product?.name || '',
954
+ RequestedQuantity: edge.node.requestedQuantity || 0,
955
+ FilledQuantity: edge.node.filledQuantity,
956
+ RejectedQuantity: edge.node.rejectedQuantity,
957
+ })) || [],
958
+ },
959
+ CreatedOn: fulfilmentData.createdOn,
960
+ UpdatedOn: fulfilmentData.updatedOn,
961
+ },
962
+ };
963
+
964
+ const xmlString = xmlBuilder.build(xmlData, 'FulfilmentExport');
965
+ const xmlBuffer = Buffer.from(xmlString, 'utf8');
966
+
967
+ log.info('✅ [BACKGROUND] XML generated successfully', {
968
+ fulfilmentRef: fulfilmentData.ref,
969
+ xmlSizeBytes: xmlBuffer.length,
970
+ xmlSizeKB: Math.round(xmlBuffer.length / 1024),
971
+ });
972
+
973
+ // ========================================
974
+ // STEP 2: UPLOAD TO SFTP
975
+ // ========================================
976
+
977
+ log.info('📤 [BACKGROUND] Preparing SFTP upload', {
978
+ fulfilmentRef: fulfilmentData.ref,
979
+ });
980
+
981
+ // ========================================
982
+ // SFTP CREDENTIAL RETRIEVAL
983
+ // ========================================
984
+
985
+ /**
986
+ * Retrieve SFTP credentials from connection configuration
987
+ *
988
+ * Connection Name: 'sftp_export_server' (must match the connection name in Versori UI)
989
+ * Auth Type: Basic Authentication (username + password)
990
+ */
991
+ log.info('🔐 [BACKGROUND] Retrieving SFTP credentials from connection configuration');
992
+
993
+ let sftpUsername: string;
994
+ let sftpPassword: string;
995
+
996
+ try {
997
+ // Retrieve credentials from the 'sftp_export_server' connection
998
+ const sftpCred = await ctx.credentials().getAccessToken('sftp_export_server');
999
+
1000
+ if (!sftpCred?.accessToken) {
1001
+ throw new Error('No SFTP credentials found in connection configuration');
1002
+ }
1003
+
1004
+ // Decode base64 accessToken to get "username:password"
1005
+ const rawBasicAuth = Buffer.from(sftpCred.accessToken, 'base64').toString('utf-8');
1006
+
1007
+ // Split on ':' to extract username and password
1008
+ const parts = rawBasicAuth.split(':');
1009
+
1010
+ if (parts.length !== 2) {
1011
+ throw new Error('Invalid SFTP credential format - expected username:password');
1012
+ }
1013
+
1014
+ sftpUsername = parts[0];
1015
+ sftpPassword = parts[1];
1016
+
1017
+ log.info('✅ [BACKGROUND] SFTP credentials retrieved successfully', {
1018
+ hasUsername: !!sftpUsername,
1019
+ hasPassword: !!sftpPassword,
1020
+ usernameLength: sftpUsername.length,
1021
+ passwordLength: sftpPassword.length,
1022
+ });
1023
+ } catch (error: any) {
1024
+ log.error('❌ [BACKGROUND] Failed to retrieve SFTP credentials', {
1025
+ message: error instanceof Error ? error.message : String(error),
1026
+ stack: error instanceof Error ? error.stack : undefined,
1027
+ errorType: error instanceof Error ? error.constructor.name : 'Error',
1028
+ recommendation: 'Please ensure the SFTP connection "sftp_export_server" is configured in the Connections section with Basic Authentication (username and password)',
1029
+ });
1030
+ throw new Error(
1031
+ `Failed to retrieve SFTP credentials from connection configuration: ${error instanceof Error ? error.message : String(error)}. ` +
1032
+ 'Please ensure the SFTP connection is configured in the Connections section with Basic Authentication (username and password)'
1033
+ );
1034
+ }
1035
+
1036
+ // Get SFTP configuration from activation variables
1037
+ const sftpHost = activation.getVariable('sftpHost');
1038
+ const sftpPort = parseInt(activation.getVariable('sftpPort') || '22', 10);
1039
+ const sftpRemotePath = activation.getVariable('sftpRemotePath') || '/incoming/fulfilments/';
1040
+
1041
+ if (!sftpHost) {
1042
+ log.error('⚠️ [BACKGROUND] SFTP configuration missing', {
1043
+ recommendation: 'Configure sftpHost activation variable',
1044
+ fulfilmentRef: fulfilmentData.ref,
1045
+ });
1046
+ throw new Error('SFTP configuration missing: sftpHost is required');
1047
+ }
1048
+
1049
+ const sftpConfig = {
1050
+ type: 'SFTP_XML' as const,
1051
+ connectionId: 'sftp_export_server',
1052
+ name: 'Fulfilment XML Export',
1053
+ settings: {
1054
+ host: sftpHost,
1055
+ port: sftpPort,
1056
+ username: sftpUsername,
1057
+ password: sftpPassword,
1058
+ },
1059
+ };
1060
+
1061
+ const sftp = new SftpDataSource(sftpConfig, log);
1062
+
1063
+ try {
1064
+ const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
1065
+ const fileName = `fulfilment-${fulfilmentData.ref}-${timestamp}.xml`;
1066
+ const remoteFilePath = `${sftpRemotePath}${fileName}`;
1067
+
1068
+ // ✅ CRITICAL FIX: Include options parameter
1069
+ await sftp.uploadFile(remoteFilePath, xmlBuffer, {
1070
+ overwrite: true,
1071
+ createDirectories: true,
1072
+ });
1073
+
1074
+ log.info('✅ [BACKGROUND] Fulfilment XML exported to SFTP', {
1075
+ fulfilmentRef: fulfilmentData.ref,
1076
+ remoteFilePath,
1077
+ status: fulfilmentData.status,
1078
+ fileSizeKB: Math.round(xmlBuffer.length / 1024),
1079
+ });
1080
+ } finally {
1081
+ // ✅ CRITICAL: Always dispose SFTP connection
1082
+ await sftp.dispose();
1083
+ log.info('🔌 [BACKGROUND] SFTP connection disposed');
1084
+ }
1085
+ }
1086
+ ```
1087
+
1088
+ ### 5. Type Definitions (src/types/fulfilment.types.ts)
1089
+
1090
+ ```typescript
1091
+ /**
1092
+ * Type definitions for Rubix fulfilment webhooks and GraphQL responses
1093
+ */
1094
+
1095
+ export interface RubixFulfilmentPayload {
1096
+ id: string;
1097
+ name: string;
1098
+ accountId: string;
1099
+ retailerId: string;
1100
+ entityRef: string;
1101
+ entityType: 'FULFILMENT';
1102
+ entityStatus?: string;
1103
+ type: 'NORMAL' | string;
1104
+ rootEntityId?: string;
1105
+ rootEntityType?: string;
1106
+ rootEntityRef?: string;
1107
+ attributes?: Record<string, any>;
1108
+ context?: Record<string, any>;
1109
+ }
1110
+
1111
+ export interface FulfilmentData {
1112
+ id: string;
1113
+ ref: string;
1114
+ status: string;
1115
+ deliveryType: string;
1116
+ order?: {
1117
+ id: string;
1118
+ ref: string;
1119
+ customer?: {
1120
+ firstName: string;
1121
+ lastName: string;
1122
+ email: string;
1123
+ };
1124
+ };
1125
+ items?: {
1126
+ edges?: Array<{
1127
+ node: {
1128
+ id: string;
1129
+ ref: string;
1130
+ requestedQuantity?: number;
1131
+ filledQuantity: number;
1132
+ rejectedQuantity: number;
1133
+ orderItem?: {
1134
+ id: string;
1135
+ ref: string;
1136
+ productRef: string;
1137
+ product?: {
1138
+ name: string;
1139
+ };
1140
+ };
1141
+ };
1142
+ }>;
1143
+ };
1144
+ toAddress?: {
1145
+ name?: string;
1146
+ street?: string;
1147
+ street2?: string;
1148
+ city?: string;
1149
+ state?: string;
1150
+ postcode?: string;
1151
+ country?: string;
1152
+ };
1153
+ fromAddress?: {
1154
+ name?: string;
1155
+ street?: string;
1156
+ street2?: string;
1157
+ city?: string;
1158
+ state?: string;
1159
+ postcode?: string;
1160
+ country?: string;
1161
+ };
1162
+ createdOn: string;
1163
+ updatedOn: string;
1164
+ }
1165
+ ```
1166
+
1167
+ ### 6. Package Configuration (package.json)
1168
+
1169
+ ```json
1170
+ {
1171
+ "name": "rubix-fulfilment-export",
1172
+ "version": "2.0.0",
1173
+ "description": "Rubix fulfilment webhook handler with SFTP XML export",
1174
+ "type": "module",
1175
+ "main": "index.ts",
1176
+ "scripts": {
1177
+ "dev": "versori dev",
1178
+ "build": "versori build",
1179
+ "deploy": "versori deploy",
1180
+ "test": "jest",
1181
+ "lint": "eslint src/**/*.ts"
1182
+ },
1183
+ "dependencies": {
1184
+ "@fluentcommerce/fc-connect-sdk": "^0.1.39",
1185
+ "@versori/run": "latest"
1186
+ },
1187
+ "devDependencies": {
1188
+ "@types/node": "^20.0.0",
1189
+ "typescript": "^5.0.0",
1190
+ "jest": "^29.0.0",
1191
+ "@types/jest": "^29.0.0",
1192
+ "eslint": "^8.0.0"
1193
+ }
1194
+ }
1195
+ ```
1196
+
1197
+ ---
1198
+
1199
+ ## Key Patterns Explained
1200
+
1201
+ ### Pattern 1: RetailerId Validation Before setRetailerId()
1202
+
1203
+ ```typescript
1204
+ // ✅ CORRECT - Validate before use
1205
+ const retailerId = payload.retailerId;
1206
+ if (!retailerId) {
1207
+ log.error('❌ [BACKGROUND] Missing retailerId in payload');
1208
+ throw new Error('retailerId is required for GraphQL operations');
1209
+ }
1210
+
1211
+ const client = await createClient({ ...ctx, log });
1212
+ await client.setRetailerId(retailerId);
1213
+
1214
+ // ❌ WRONG - No validation
1215
+ await client.setRetailerId(retailerId); // May be undefined!
1216
+ ```
1217
+
1218
+ **Why:** Missing retailerId causes 401 authentication errors with unclear messages.
1219
+
1220
+ ### Pattern 2: SFTP uploadFile with Options Parameter
1221
+
1222
+ ```typescript
1223
+ // ✅ CORRECT - Include options parameter
1224
+ await sftp.uploadFile(remoteFilePath, xmlBuffer, {
1225
+ overwrite: true,
1226
+ createDirectories: true,
1227
+ });
1228
+
1229
+ // ❌ WRONG - Missing options (works but not explicit)
1230
+ await sftp.uploadFile(remoteFilePath, xmlBuffer);
1231
+ ```
1232
+
1233
+ **Why:** Explicit options make behavior clear and prevent production surprises.
1234
+
1235
+ ### Pattern 3: SDK Error Type Handling
1236
+
1237
+ ```typescript
1238
+ // ✅ CORRECT - Handle SDK error types
1239
+ import {
1240
+ DataSourceError,
1241
+ AuthenticationError,
1242
+ GraphQLError,
1243
+ } from '@fluentcommerce/fc-connect-sdk';
1244
+
1245
+ catch (error: unknown) {
1246
+ if (error instanceof GraphQLError) {
1247
+ errorCategory = 'GRAPHQL';
1248
+ recommendation = 'Review query syntax';
1249
+ } else if (error instanceof AuthenticationError) {
1250
+ errorCategory = 'AUTHENTICATION';
1251
+ recommendation = 'Verify credentials';
1252
+ } else if (error instanceof DataSourceError) {
1253
+ errorCategory = 'DATA_SOURCE';
1254
+ recommendation = 'Check SFTP config';
1255
+ }
1256
+ }
1257
+
1258
+ // ❌ WRONG - Generic error handling
1259
+ catch (error: unknown) {
1260
+ const message = error instanceof Error ? error.message : String(error);
1261
+ // No categorization or recommendations
1262
+ }
1263
+ ```
1264
+
1265
+ **Why:** SDK errors include recommendations for resolution.
1266
+
1267
+ ---
1268
+
1269
+ ## Testing
1270
+
1271
+ ### 1. Unit Tests
1272
+
1273
+ ```typescript
1274
+ // src/services/__tests__/fulfilment-query.test.ts
1275
+ import { processFulfilmentExport } from '../fulfilment-query.service';
1276
+
1277
+ describe('Fulfilment Query Service', () => {
1278
+ test('should export fulfilment successfully', async () => {
1279
+ const mockCtx = {
1280
+ log: { info: jest.fn(), error: jest.fn() },
1281
+ activation: { getVariable: jest.fn() },
1282
+ };
1283
+
1284
+ const payload = {
1285
+ entityRef: 'FF-001',
1286
+ entityType: 'FULFILMENT',
1287
+ retailerId: '1',
1288
+ };
1289
+
1290
+ await expect(processFulfilmentExport(mockCtx, payload)).resolves.not.toThrow();
1291
+ });
1292
+
1293
+ test('should handle large fulfilment with pagination', async () => {
1294
+ const mockCtx = {
1295
+ log: { info: jest.fn(), error: jest.fn() },
1296
+ activation: { getVariable: jest.fn() },
1297
+ };
1298
+
1299
+ const payload = {
1300
+ entityRef: 'FF-LARGE-001', // Fulfilment with 150 items
1301
+ entityType: 'FULFILMENT',
1302
+ retailerId: '1',
1303
+ };
1304
+
1305
+ await expect(processFulfilmentExport(mockCtx, payload)).resolves.not.toThrow();
1306
+
1307
+ // Verify pagination was logged
1308
+ expect(mockCtx.log.info).toHaveBeenCalledWith(
1309
+ expect.stringContaining('Fulfilment and items queried successfully'),
1310
+ expect.objectContaining({
1311
+ itemCount: 150,
1312
+ paginationUsed: true,
1313
+ })
1314
+ );
1315
+ });
1316
+ });
1317
+ ```
1318
+
1319
+ ### 2. Integration Test
1320
+
1321
+ ```bash
1322
+ # Test webhook with valid signature
1323
+ curl -X POST https://workspace.versori.run/rubix-fulfilment \
1324
+ -H "Content-Type: application/json" \
1325
+ -H "fluent-signature: <valid-signature>" \
1326
+ -d '{
1327
+ "entityType": "FULFILMENT",
1328
+ "entityRef": "FF-001",
1329
+ "retailerId": "1"
1330
+ }'
1331
+
1332
+ # Expected: 200 OK with { success: true, message: "..." }
1333
+ ```
1334
+
1335
+ ---
1336
+
1337
+ ## Production Checklist
1338
+
1339
+ - [ ] Configure `fluentPublicKey` activation variable
1340
+ - [ ] Configure Fluent Commerce connection in Versori
1341
+ - [ ] Configure `sftp_export_server` connection in Versori (Basic Auth with username/password)
1342
+ - [ ] Set SFTP activation variables (host, port, remotePath)
1343
+ - [ ] Verify SFTP remote path exists and is writable
1344
+ - [ ] Create Rubix workflow with SendWebhook action (FULFILMENT events)
1345
+ - [ ] Build Event payload with entityRef, entityType, retailerId
1346
+ - [ ] Test webhook signature validation
1347
+ - [ ] Test GraphQL query with real fulfilment ref
1348
+ - [ ] **Test with large fulfilment (>100 items)** - Verify pagination works correctly
1349
+ - [ ] Test XML generation with special characters
1350
+ - [ ] Test SFTP upload and verify file on server
1351
+ - [ ] Test error scenarios (invalid signature, missing retailerId, SFTP failure)
1352
+ - [ ] Monitor response times (<100ms for validation)
1353
+ - [ ] Set up alerts for webhook/export failures
1354
+ - [ ] Document 3PL partner SFTP requirements
1355
+ - [ ] Test SFTP connection cleanup (check logs for dispose)
1356
+ - [ ] Verify pagination logs show correct item counts
1357
+
1358
+ ---
1359
+
1360
+ ## Troubleshooting Guide
1361
+
1362
+ | Issue | Cause | Solution |
1363
+ |-------|-------|----------|
1364
+ | "Invalid webhook signature" | Wrong public key | Verify fluentPublicKey matches Fluent environment |
1365
+ | "Missing retailerId" | Rubix payload incomplete | Add retailerId to Rubix Event payload builder |
1366
+ | "Fulfilment not found" | Invalid ref or permissions | Verify fulfilment exists and user has query permissions |
1367
+ | "SFTP upload failed" | Connection/credentials | Test SFTP manually, verify credentials in connection and path |
1368
+ | "Failed to retrieve SFTP credentials" | Connection not configured | Ensure `sftp_export_server` connection exists with Basic Auth |
1369
+ | "SFTP connection pool exhausted" | Missing dispose() | Verify dispose() is in finally block |
1370
+ | "GraphQL query timeout" | Large dataset | Check pagination logs - pagination handles up to 1000 items |
1371
+ | "Missing items in XML" | Fulfilment >1000 items | Increase maxPages limit or implement chunked export |
1372
+
1373
+ ---
1374
+
1375
+ ## Monitoring & Alerting
1376
+
1377
+ ### Success Response
1378
+
1379
+ ```json
1380
+ {
1381
+ "success": true,
1382
+ "entityType": "FULFILMENT",
1383
+ "fulfilmentRef": "FF-001",
1384
+ "message": "Webhook validated and export started in background",
1385
+ "timestamp": "2025-01-25T14:30:00.000Z",
1386
+ "correlationId": "act_123",
1387
+ "processingMode": "async"
1388
+ }
1389
+ ```
1390
+
1391
+ ### Key Metrics
1392
+
1393
+ ```typescript
1394
+ const METRICS = {
1395
+ signatureValidationMs: 45,
1396
+ totalResponseTimeMs: 50,
1397
+ graphqlQueryMs: 1200,
1398
+ xmlGenerationMs: 50,
1399
+ sftpUploadMs: 980,
1400
+ totalBackgroundMs: 2230,
1401
+ };
1402
+ ```
1403
+
1404
+ ---
1405
+
1406
+ ## Related Documentation
1407
+
1408
+ - [Order Attribute Update Template](./template-webhook-rubix-order-attribute-update.md) - For ORDER webhooks
1409
+ - [Webhook Validation Guide](../../../../02-CORE-GUIDES/webhook-validation/)
1410
+ - [Versori Platform Guide](../../../../04-REFERENCE/platforms/versori/)
1411
+ - [SFTP Data Sources Guide](../../../../02-CORE-GUIDES/data-sources/)
1412
+
1413
+ ---
1414
+
1415
+ **Pattern**: Fulfilment webhook → GraphQL query → XML generation → SFTP upload
1416
+ **✅ Production-Ready**: Comprehensive template with all critical fixes applied
1417
+ **Key Learning**: Always validate retailerId, use proper SFTP options, handle SDK errors
1418
+ **Critical**: SFTP dispose() in finally block, retailerId validation, fire-and-forget pattern