@fluentcommerce/fc-connect-sdk 0.1.54 → 0.1.55

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (475) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/cjs/clients/fluent-client.js +13 -6
  3. package/dist/cjs/utils/pagination-helpers.js +38 -2
  4. package/dist/cjs/versori/fluent-versori-client.js +11 -5
  5. package/dist/esm/clients/fluent-client.js +13 -6
  6. package/dist/esm/utils/pagination-helpers.js +38 -2
  7. package/dist/esm/versori/fluent-versori-client.js +11 -5
  8. package/dist/tsconfig.esm.tsbuildinfo +1 -1
  9. package/dist/tsconfig.tsbuildinfo +1 -1
  10. package/dist/tsconfig.types.tsbuildinfo +1 -1
  11. package/docs/00-START-HERE/EXPORT-VALIDATION.md +158 -158
  12. package/docs/00-START-HERE/cli-analyze-source-structure-guide.md +655 -655
  13. package/docs/00-START-HERE/cli-documentation-index.md +202 -202
  14. package/docs/00-START-HERE/cli-quick-reference.md +252 -252
  15. package/docs/00-START-HERE/decision-tree.md +552 -552
  16. package/docs/00-START-HERE/getting-started.md +1070 -1070
  17. package/docs/00-START-HERE/mapper-quick-decision-guide.md +235 -235
  18. package/docs/00-START-HERE/readme.md +237 -237
  19. package/docs/00-START-HERE/retailerid-configuration.md +404 -404
  20. package/docs/00-START-HERE/sdk-philosophy.md +794 -794
  21. package/docs/00-START-HERE/troubleshooting-quick-reference.md +1086 -1086
  22. package/docs/01-TEMPLATES/faq.md +686 -686
  23. package/docs/01-TEMPLATES/patterns/pattern-templates-guide.md +68 -68
  24. package/docs/01-TEMPLATES/patterns/patterns-csv-schema-validation-and-rejection-report.md +233 -233
  25. package/docs/01-TEMPLATES/patterns/patterns-custom-resolvers.md +407 -407
  26. package/docs/01-TEMPLATES/patterns/patterns-error-handling-retry.md +511 -511
  27. package/docs/01-TEMPLATES/patterns/patterns-field-mapping-universal.md +701 -701
  28. package/docs/01-TEMPLATES/patterns/patterns-large-file-splitting.md +1430 -1430
  29. package/docs/01-TEMPLATES/patterns/patterns-master-data-etl.md +2399 -2399
  30. package/docs/01-TEMPLATES/patterns/patterns-pagination-streaming.md +447 -447
  31. package/docs/01-TEMPLATES/patterns/patterns-state-duplicate-prevention.md +385 -385
  32. package/docs/01-TEMPLATES/readme.md +957 -957
  33. package/docs/01-TEMPLATES/standalone/standalone-asn-inbound-processing.md +1209 -1209
  34. package/docs/01-TEMPLATES/standalone/standalone-graphql-query-export.md +1140 -1140
  35. package/docs/01-TEMPLATES/standalone/standalone-graphql-to-parquet-partitioned-s3.md +432 -432
  36. package/docs/01-TEMPLATES/standalone/standalone-multi-channel-inventory-sync.md +1185 -1185
  37. package/docs/01-TEMPLATES/standalone/standalone-multi-source-aggregation.md +1462 -1462
  38. package/docs/01-TEMPLATES/standalone/standalone-s3-csv-batch-api.md +1390 -1390
  39. package/docs/01-TEMPLATES/standalone/standalone-s3-csv-inventory-to-batch.md +330 -330
  40. package/docs/01-TEMPLATES/standalone/standalone-scripts-guide.md +87 -87
  41. package/docs/01-TEMPLATES/standalone/standalone-sftp-xml-graphql.md +1444 -1444
  42. package/docs/01-TEMPLATES/standalone/standalone-webhook-payload-processing.md +688 -688
  43. package/docs/01-TEMPLATES/versori/business-examples/business-examples-dropship-order-routing.md +193 -193
  44. package/docs/01-TEMPLATES/versori/business-examples/business-examples-graphql-parquet-extraction.md +518 -518
  45. package/docs/01-TEMPLATES/versori/business-examples/business-examples-inter-location-transfers.md +2162 -2162
  46. package/docs/01-TEMPLATES/versori/business-examples/business-examples-pre-order-allocation.md +2226 -2226
  47. package/docs/01-TEMPLATES/versori/business-examples/business-scenarios-guide.md +87 -87
  48. package/docs/01-TEMPLATES/versori/patterns/versori-patterns-connection-validation-pattern.md +656 -656
  49. package/docs/01-TEMPLATES/versori/patterns/versori-patterns-dual-workflow-connector.md +835 -835
  50. package/docs/01-TEMPLATES/versori/patterns/versori-patterns-guide.md +108 -108
  51. package/docs/01-TEMPLATES/versori/patterns/versori-patterns-kv-state-management.md +1533 -1533
  52. package/docs/01-TEMPLATES/versori/patterns/versori-patterns-xml-response-patterns.md +1160 -1160
  53. package/docs/01-TEMPLATES/versori/versori-platform-guide.md +201 -201
  54. package/docs/01-TEMPLATES/versori/webhooks/template-webhook-asn-purchase-order.md +1906 -1906
  55. package/docs/01-TEMPLATES/versori/webhooks/template-webhook-dropship-routing.md +1074 -1074
  56. package/docs/01-TEMPLATES/versori/webhooks/template-webhook-flash-sale-reserve.md +1395 -1395
  57. package/docs/01-TEMPLATES/versori/webhooks/template-webhook-generic-xml-order.md +888 -888
  58. package/docs/01-TEMPLATES/versori/webhooks/template-webhook-payment-gateway-integration.md +2478 -2478
  59. package/docs/01-TEMPLATES/versori/webhooks/template-webhook-rma-returns-comprehensive.md +2240 -2240
  60. package/docs/01-TEMPLATES/versori/webhooks/template-webhook-xml-order-ingestion.md +2029 -2029
  61. package/docs/01-TEMPLATES/versori/webhooks/webhook-templates-guide.md +140 -140
  62. package/docs/01-TEMPLATES/versori/workflows/_examples/sample-data/inventory-mapping.json +20 -20
  63. package/docs/01-TEMPLATES/versori/workflows/_examples/sample-data/products_2025-01-22.csv +11 -11
  64. package/docs/01-TEMPLATES/versori/workflows/_examples/sample-data/sample-data-guide.md +34 -34
  65. package/docs/01-TEMPLATES/versori/workflows/_examples/workflow-examples-guide.md +36 -36
  66. package/docs/01-TEMPLATES/versori/workflows/extraction/extraction-modes-guide.md +1038 -1038
  67. package/docs/01-TEMPLATES/versori/workflows/extraction/extraction-workflows-guide.md +138 -138
  68. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/graphql-extraction-guide.md +63 -63
  69. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-fulfillments-to-sftp-csv.md +2062 -2062
  70. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-fulfillments-to-sftp-xml.md +2294 -2294
  71. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-inventory-positions-to-s3-csv.md +2461 -2461
  72. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-inventory-positions-to-sftp-xml.md +2529 -2529
  73. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-inventory-quantities-to-s3-csv.md +2464 -2464
  74. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-inventory-quantities-to-s3-json.md +1959 -1959
  75. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-orders-to-s3-csv.md +1953 -1953
  76. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-orders-to-sftp-xml.md +2541 -2541
  77. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-products-to-s3-json.md +2384 -2384
  78. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-products-to-sftp-xml.md +2445 -2445
  79. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-virtual-positions-to-s3-csv.md +2355 -2355
  80. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-virtual-positions-to-s3-json.md +2042 -2042
  81. package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-virtual-positions-to-sftp-xml.md +2726 -2726
  82. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/batch-api-guide.md +206 -206
  83. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-cycle-count-reconciliation.md +2030 -2030
  84. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-multi-channel-inventory-sync.md +1882 -1882
  85. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-s3-csv-inventory-batch.md +2827 -2827
  86. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-s3-json-inventory-batch.md +1952 -1952
  87. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-s3-xml-inventory-batch.md +3289 -3289
  88. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-sftp-csv-inventory-batch.md +3064 -3064
  89. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-sftp-json-inventory-batch.md +3238 -3238
  90. package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-sftp-xml-inventory-batch.md +2977 -2977
  91. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/event-api-guide.md +321 -321
  92. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-payload-json-order-cancel-event.md +959 -959
  93. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-payload-xml-order-cancel-event.md +1170 -1170
  94. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-s3-csv-product-event.md +2312 -2312
  95. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-s3-json-product-event.md +2999 -2999
  96. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-s3-parquet-product-event.md +2836 -2836
  97. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-s3-xml-product-event.md +2395 -2395
  98. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-sftp-csv-product-event.md +2295 -2295
  99. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-sftp-json-product-event.md +2602 -2602
  100. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-sftp-parquet-product-event.md +2589 -2589
  101. package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-sftp-xml-product-event.md +3578 -3578
  102. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/graphql-mutations-guide.md +93 -93
  103. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-payload-json-order-update-graphql.md +1260 -1260
  104. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-payload-xml-order-update-graphql.md +1472 -1472
  105. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-csv-control-graphql.md +2417 -2417
  106. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-csv-location-graphql.md +2811 -2811
  107. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-csv-price-graphql.md +2619 -2619
  108. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-json-location-graphql.md +2807 -2807
  109. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-xml-location-graphql.md +2373 -2373
  110. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-sftp-csv-control-graphql.md +2740 -2740
  111. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-sftp-csv-location-graphql.md +2760 -2760
  112. package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-sftp-json-location-graphql.md +1710 -1710
  113. package/docs/01-TEMPLATES/versori/workflows/ingestion/ingestion-workflows-guide.md +136 -136
  114. package/docs/01-TEMPLATES/versori/workflows/rubix-webhooks/rubix-webhooks-guide.md +520 -520
  115. package/docs/01-TEMPLATES/versori/workflows/rubix-webhooks/template-webhook-rubix-fulfilment-to-sftp-xml-inline.md +1418 -1418
  116. package/docs/01-TEMPLATES/versori/workflows/rubix-webhooks/template-webhook-rubix-fulfilment-to-sftp-xml-universal-mapper.md +1785 -1785
  117. package/docs/01-TEMPLATES/versori/workflows/rubix-webhooks/template-webhook-rubix-order-attribute-update.md +824 -824
  118. package/docs/01-TEMPLATES/versori/workflows/workflows-overview-guide.md +646 -646
  119. package/docs/02-CORE-GUIDES/advanced-services/advanced-services-batch-archival.md +724 -724
  120. package/docs/02-CORE-GUIDES/advanced-services/advanced-services-job-tracker.md +627 -627
  121. package/docs/02-CORE-GUIDES/advanced-services/advanced-services-partial-batch-recovery.md +561 -561
  122. package/docs/02-CORE-GUIDES/advanced-services/advanced-services-quick-reference.md +367 -367
  123. package/docs/02-CORE-GUIDES/advanced-services/advanced-services-readme.md +407 -407
  124. package/docs/02-CORE-GUIDES/advanced-services/readme.md +49 -49
  125. package/docs/02-CORE-GUIDES/api-reference/api-reference-quick-reference.md +548 -548
  126. package/docs/02-CORE-GUIDES/api-reference/event-api-input-output-reference.md +702 -1171
  127. package/docs/02-CORE-GUIDES/api-reference/examples/client-initialization.ts +286 -286
  128. package/docs/02-CORE-GUIDES/api-reference/graphql-error-classification.md +337 -337
  129. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-01-client-api.md +399 -520
  130. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-03-authentication.md +199 -199
  131. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-04-graphql-mapping.md +925 -925
  132. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-05-services.md +1198 -1198
  133. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-06-data-sources.md +1083 -1083
  134. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-07-parsers.md +1097 -1097
  135. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-08-pagination.md +513 -513
  136. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-08-types.md +545 -597
  137. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-09-error-handling.md +527 -527
  138. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-09-webhook-validation.md +514 -514
  139. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-10-extraction.md +557 -557
  140. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-10-utilities.md +412 -412
  141. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-11-cli-tools.md +423 -423
  142. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-11-error-handling.md +716 -716
  143. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-12-analyze-source-structure.md +518 -518
  144. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-12-partial-responses.md +212 -212
  145. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-12-testing.md +300 -300
  146. package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-13-resolver-builder.md +322 -322
  147. package/docs/02-CORE-GUIDES/api-reference/readme.md +279 -279
  148. package/docs/02-CORE-GUIDES/auto-pagination/auto-pagination-quick-reference.md +351 -351
  149. package/docs/02-CORE-GUIDES/auto-pagination/auto-pagination-readme.md +277 -277
  150. package/docs/02-CORE-GUIDES/auto-pagination/examples/auto-pagination-readme.md +178 -178
  151. package/docs/02-CORE-GUIDES/auto-pagination/examples/common-patterns.ts +351 -351
  152. package/docs/02-CORE-GUIDES/auto-pagination/examples/paginate-products.ts +384 -384
  153. package/docs/02-CORE-GUIDES/auto-pagination/examples/paginate-virtual-positions.ts +308 -308
  154. package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-01-foundations.md +470 -470
  155. package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-02-quick-start.md +713 -713
  156. package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-03-configuration.md +754 -754
  157. package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-04-advanced-patterns.md +732 -732
  158. package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-05-sdk-integration.md +847 -847
  159. package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-06-troubleshooting.md +359 -359
  160. package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-07-api-reference.md +462 -462
  161. package/docs/02-CORE-GUIDES/auto-pagination/readme.md +54 -54
  162. package/docs/02-CORE-GUIDES/data-sources/data-sources-file-operations-error-handling.md +1487 -1487
  163. package/docs/02-CORE-GUIDES/data-sources/data-sources-quick-reference.md +836 -836
  164. package/docs/02-CORE-GUIDES/data-sources/data-sources-readme.md +276 -276
  165. package/docs/02-CORE-GUIDES/data-sources/data-sources-sftp-credential-access-security.md +553 -553
  166. package/docs/02-CORE-GUIDES/data-sources/examples/common-patterns.ts +409 -409
  167. package/docs/02-CORE-GUIDES/data-sources/examples/data-sources-readme.md +178 -178
  168. package/docs/02-CORE-GUIDES/data-sources/examples/s3-operations.ts +308 -308
  169. package/docs/02-CORE-GUIDES/data-sources/examples/sftp-operations.ts +371 -371
  170. package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-01-foundations.md +735 -735
  171. package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-02-s3-operations.md +1302 -1302
  172. package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-03-sftp-operations.md +1379 -1379
  173. package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-04-file-patterns.md +941 -941
  174. package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-05-advanced-topics.md +813 -813
  175. package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-06-integration-patterns.md +486 -486
  176. package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-07-troubleshooting.md +387 -387
  177. package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-08-api-reference.md +417 -417
  178. package/docs/02-CORE-GUIDES/data-sources/readme.md +77 -77
  179. package/docs/02-CORE-GUIDES/error-handling-guide.md +936 -936
  180. package/docs/02-CORE-GUIDES/extraction/examples/02-core-guides-extraction-readme.md +116 -116
  181. package/docs/02-CORE-GUIDES/extraction/examples/common-patterns.ts +428 -428
  182. package/docs/02-CORE-GUIDES/extraction/examples/extract-inventory-basic.ts +187 -187
  183. package/docs/02-CORE-GUIDES/extraction/extraction-quick-reference.md +596 -596
  184. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-01-foundations.md +514 -514
  185. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-02-basic-extraction.md +823 -823
  186. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-03-parquet-processing.md +507 -507
  187. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-04-data-enrichment.md +546 -546
  188. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-05-transformation.md +494 -494
  189. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-06-export-formats.md +458 -458
  190. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-06-performance.md +138 -138
  191. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-07-api-reference.md +148 -148
  192. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-07-optimization.md +692 -692
  193. package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-08-extraction-orchestrator.md +1008 -1008
  194. package/docs/02-CORE-GUIDES/extraction/readme.md +151 -151
  195. package/docs/02-CORE-GUIDES/ingestion/examples/_simple-kv-store.ts +40 -40
  196. package/docs/02-CORE-GUIDES/ingestion/examples/error-recovery.ts +728 -728
  197. package/docs/02-CORE-GUIDES/ingestion/examples/event-driven.ts +501 -501
  198. package/docs/02-CORE-GUIDES/ingestion/examples/local-file-ingestion.ts +88 -88
  199. package/docs/02-CORE-GUIDES/ingestion/examples/parquet-ingestion.ts +117 -117
  200. package/docs/02-CORE-GUIDES/ingestion/examples/performance-optimized.ts +647 -647
  201. package/docs/02-CORE-GUIDES/ingestion/examples/s3-csv-ingestion.ts +169 -169
  202. package/docs/02-CORE-GUIDES/ingestion/examples/sftp-csv-ingestion.ts +134 -134
  203. package/docs/02-CORE-GUIDES/ingestion/ingestion-quick-reference.md +546 -546
  204. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-01-introduction.md +626 -626
  205. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-02-quick-start.md +658 -658
  206. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-03-data-sources.md +1052 -1052
  207. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-04-field-mapping.md +763 -763
  208. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-05-advanced-parsers.md +676 -676
  209. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-06-batch-api.md +1295 -1295
  210. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-07-api-reference.md +138 -138
  211. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-07-state-management.md +1037 -1037
  212. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-08-performance-optimization.md +1349 -1349
  213. package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-09-best-practices.md +1893 -1893
  214. package/docs/02-CORE-GUIDES/ingestion/readme.md +160 -160
  215. package/docs/02-CORE-GUIDES/logging-guide.md +585 -585
  216. package/docs/02-CORE-GUIDES/mapping/error-handling-patterns.md +401 -401
  217. package/docs/02-CORE-GUIDES/mapping/examples/02-core-guides-mapping-readme.md +128 -128
  218. package/docs/02-CORE-GUIDES/mapping/examples/common-patterns.ts +273 -273
  219. package/docs/02-CORE-GUIDES/mapping/examples/csv-location-ingestion.json +36 -36
  220. package/docs/02-CORE-GUIDES/mapping/examples/csv-mapping.ts +242 -242
  221. package/docs/02-CORE-GUIDES/mapping/examples/graphql-to-parquet-extraction.json +36 -36
  222. package/docs/02-CORE-GUIDES/mapping/examples/json-mapping.ts +213 -213
  223. package/docs/02-CORE-GUIDES/mapping/examples/json-product-to-mutation.json +48 -48
  224. package/docs/02-CORE-GUIDES/mapping/examples/xml-mapping.ts +291 -291
  225. package/docs/02-CORE-GUIDES/mapping/examples/xml-order-to-mutation.json +45 -45
  226. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/graphql-mutation-mapping-quick-reference.md +463 -463
  227. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/graphql-mutation-mapping-readme.md +227 -227
  228. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-01-introduction.md +222 -222
  229. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-02-quick-start.md +351 -351
  230. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-03-schema-validation.md +569 -569
  231. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-04-mapping-patterns.md +471 -471
  232. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-05-configuration-reference.md +611 -611
  233. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-06-advanced-xpath.md +148 -148
  234. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-06-path-syntax.md +464 -464
  235. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-07-api-reference.md +94 -94
  236. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-07-array-handling.md +307 -307
  237. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-08-custom-resolvers.md +544 -544
  238. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-09-advanced-patterns.md +427 -427
  239. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-10-hooks-and-variables.md +336 -336
  240. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-11-error-handling.md +488 -488
  241. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-12-arguments-vs-nodes.md +383 -383
  242. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-13-best-practices.md +477 -477
  243. package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/readme.md +62 -62
  244. package/docs/02-CORE-GUIDES/mapping/mapping-format-decision-tree.md +480 -480
  245. package/docs/02-CORE-GUIDES/mapping/mapping-graphql-alias-batching-guide.md +820 -820
  246. package/docs/02-CORE-GUIDES/mapping/mapping-javascript-objects.md +2369 -2369
  247. package/docs/02-CORE-GUIDES/mapping/mapping-mapper-comparison-guide.md +682 -682
  248. package/docs/02-CORE-GUIDES/mapping/modules/02-core-guides-mapping-07-api-reference.md +1327 -1327
  249. package/docs/02-CORE-GUIDES/mapping/modules/02-core-guides-mapping-08-error-handling.md +1142 -1142
  250. package/docs/02-CORE-GUIDES/mapping/modules/mapping-04-use-cases.md +891 -891
  251. package/docs/02-CORE-GUIDES/mapping/modules/mapping-06-helpers-resolvers.md +1126 -1126
  252. package/docs/02-CORE-GUIDES/mapping/modules/mapping-06-sdk-resolvers.md +199 -199
  253. package/docs/02-CORE-GUIDES/mapping/modules/mapping-07-api-reference.md +1319 -1319
  254. package/docs/02-CORE-GUIDES/mapping/readme.md +178 -178
  255. package/docs/02-CORE-GUIDES/mapping/resolver-registration.md +410 -410
  256. package/docs/02-CORE-GUIDES/mapping/resolvers/examples/common-patterns.ts +226 -226
  257. package/docs/02-CORE-GUIDES/mapping/resolvers/examples/custom-resolvers.ts +227 -227
  258. package/docs/02-CORE-GUIDES/mapping/resolvers/examples/sdk-resolvers-usage.ts +203 -203
  259. package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-readme.md +274 -274
  260. package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-api-reference.md +679 -679
  261. package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-cookbook.md +826 -826
  262. package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-guide.md +1330 -1330
  263. package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-helpers-reference.md +1437 -1437
  264. package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-parameters-reference.md +553 -553
  265. package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-troubleshooting.md +854 -854
  266. package/docs/02-CORE-GUIDES/mapping/resolvers/readme.md +75 -75
  267. package/docs/02-CORE-GUIDES/parsers/examples/02-core-guides-parsers-readme.md +161 -161
  268. package/docs/02-CORE-GUIDES/parsers/examples/csv-parser-examples.ts +110 -110
  269. package/docs/02-CORE-GUIDES/parsers/examples/json-parser-examples.ts +33 -33
  270. package/docs/02-CORE-GUIDES/parsers/examples/parquet-parser-examples.ts +47 -47
  271. package/docs/02-CORE-GUIDES/parsers/examples/xml-parser-examples.ts +38 -38
  272. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-01-foundations.md +355 -355
  273. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-02-csv-parser.md +772 -772
  274. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-03-json-parser.md +789 -789
  275. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-04-xml-parser.md +857 -857
  276. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-05-parquet-parser.md +603 -603
  277. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-06-integration-patterns.md +702 -702
  278. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-06-streaming.md +121 -121
  279. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-07-api-reference.md +89 -89
  280. package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-07-troubleshooting.md +727 -727
  281. package/docs/02-CORE-GUIDES/parsers/parsers-quick-reference.md +482 -482
  282. package/docs/02-CORE-GUIDES/parsers/parsers-readme.md +258 -258
  283. package/docs/02-CORE-GUIDES/parsers/readme.md +65 -65
  284. package/docs/02-CORE-GUIDES/readme.md +194 -194
  285. package/docs/02-CORE-GUIDES/webhook-validation/examples/basic-validation.ts +108 -108
  286. package/docs/02-CORE-GUIDES/webhook-validation/examples/common-patterns.ts +316 -316
  287. package/docs/02-CORE-GUIDES/webhook-validation/examples/webhook-validation-readme.md +61 -61
  288. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-01-foundations.md +440 -440
  289. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-02-quick-start.md +525 -525
  290. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-03-versori-integration.md +741 -741
  291. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-04-platform-integration.md +629 -629
  292. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-05-configuration.md +535 -535
  293. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-06-error-handling.md +611 -611
  294. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-06-troubleshooting.md +124 -124
  295. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-07-api-reference.md +511 -511
  296. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-08-rubix-webhooks.md +590 -590
  297. package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-09-rubix-event-vs-http-call.md +432 -432
  298. package/docs/02-CORE-GUIDES/webhook-validation/readme.md +239 -239
  299. package/docs/02-CORE-GUIDES/webhook-validation/webhook-validation-quick-reference.md +392 -392
  300. package/docs/03-PATTERN-GUIDES/connector-scenarios/connector-scenarios-quick-reference.md +498 -498
  301. package/docs/03-PATTERN-GUIDES/connector-scenarios/connector-scenarios-readme.md +313 -313
  302. package/docs/03-PATTERN-GUIDES/connector-scenarios/examples/common-patterns.ts +612 -612
  303. package/docs/03-PATTERN-GUIDES/connector-scenarios/examples/connector-scenarios-readme.md +253 -253
  304. package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-01-foundations.md +452 -452
  305. package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-02-simple-scenarios.md +681 -681
  306. package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-03-intermediate-scenarios.md +637 -637
  307. package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-04-advanced-scenarios.md +650 -650
  308. package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-05-bidirectional-sync.md +233 -233
  309. package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-06-production-patterns.md +442 -442
  310. package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-07-reference.md +445 -445
  311. package/docs/03-PATTERN-GUIDES/connector-scenarios/readme.md +31 -31
  312. package/docs/03-PATTERN-GUIDES/enterprise-integration-patterns.md +1528 -1528
  313. package/docs/03-PATTERN-GUIDES/error-handling/comprehensive-error-handling-guide.md +1437 -1437
  314. package/docs/03-PATTERN-GUIDES/error-handling/error-handling-quick-reference.md +390 -390
  315. package/docs/03-PATTERN-GUIDES/error-handling/examples/common-patterns.ts +438 -438
  316. package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-01-foundations.md +362 -362
  317. package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-02-error-types.md +850 -850
  318. package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-03-utf8-handling.md +456 -456
  319. package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-04-error-scenarios.md +658 -658
  320. package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-05-calling-patterns.md +671 -671
  321. package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-06-retry-strategies.md +1034 -1034
  322. package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-07-monitoring.md +653 -653
  323. package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-08-api-reference.md +847 -847
  324. package/docs/03-PATTERN-GUIDES/error-handling/readme.md +36 -36
  325. package/docs/03-PATTERN-GUIDES/examples/__tests__/readme.md +40 -40
  326. package/docs/03-PATTERN-GUIDES/examples/__tests__/resolver-examples.test.js +282 -282
  327. package/docs/03-PATTERN-GUIDES/examples/test-data/03-pattern-guides-readme.md +110 -110
  328. package/docs/03-PATTERN-GUIDES/examples/test-data/canonical-inventory.json +123 -123
  329. package/docs/03-PATTERN-GUIDES/examples/test-data/canonical-order.json +171 -171
  330. package/docs/03-PATTERN-GUIDES/examples/test-data/readme.md +28 -28
  331. package/docs/03-PATTERN-GUIDES/extraction/extraction-readme.md +15 -15
  332. package/docs/03-PATTERN-GUIDES/extraction/readme.md +25 -25
  333. package/docs/03-PATTERN-GUIDES/file-operations/examples/common-patterns.ts +407 -407
  334. package/docs/03-PATTERN-GUIDES/file-operations/examples/file-operations-readme.md +142 -142
  335. package/docs/03-PATTERN-GUIDES/file-operations/file-operations-quick-reference.md +462 -462
  336. package/docs/03-PATTERN-GUIDES/file-operations/file-operations-readme.md +379 -379
  337. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-01-foundations.md +430 -430
  338. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-02-quick-start.md +484 -484
  339. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-03-s3-operations.md +507 -507
  340. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-04-sftp-operations.md +963 -963
  341. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-05-streaming-performance.md +503 -503
  342. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-06-archive-patterns.md +386 -386
  343. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-06-error-handling.md +117 -117
  344. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-07-api-reference.md +78 -78
  345. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-07-testing-troubleshooting.md +567 -567
  346. package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-08-api-reference.md +1055 -1055
  347. package/docs/03-PATTERN-GUIDES/file-operations/readme.md +32 -32
  348. package/docs/03-PATTERN-GUIDES/ingestion/ingestion-readme.md +15 -15
  349. package/docs/03-PATTERN-GUIDES/ingestion/readme.md +25 -25
  350. package/docs/03-PATTERN-GUIDES/integration-patterns/examples/batch-processing.ts +130 -130
  351. package/docs/03-PATTERN-GUIDES/integration-patterns/examples/common-patterns.ts +360 -360
  352. package/docs/03-PATTERN-GUIDES/integration-patterns/examples/delta-sync.ts +130 -130
  353. package/docs/03-PATTERN-GUIDES/integration-patterns/examples/integration-patterns-readme.md +100 -100
  354. package/docs/03-PATTERN-GUIDES/integration-patterns/examples/real-time-webhook.ts +398 -398
  355. package/docs/03-PATTERN-GUIDES/integration-patterns/integration-patterns-quick-reference.md +962 -962
  356. package/docs/03-PATTERN-GUIDES/integration-patterns/integration-patterns-readme.md +134 -134
  357. package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-01-real-time-processing.md +991 -991
  358. package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-02-batch-processing.md +1547 -1547
  359. package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-03-delta-sync.md +1108 -1108
  360. package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-04-webhook-patterns.md +1181 -1181
  361. package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-05-error-handling.md +1061 -1061
  362. package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-06-advanced-integration-services.md +1547 -1547
  363. package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-06-performance.md +109 -109
  364. package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-07-api-reference.md +34 -34
  365. package/docs/03-PATTERN-GUIDES/integration-patterns/readme.md +30 -30
  366. package/docs/03-PATTERN-GUIDES/logging-minimal-mode.md +128 -128
  367. package/docs/03-PATTERN-GUIDES/multiple-connections/examples/common-patterns.ts +380 -380
  368. package/docs/03-PATTERN-GUIDES/multiple-connections/examples/multiple-connections-readme.md +139 -139
  369. package/docs/03-PATTERN-GUIDES/multiple-connections/examples/parallel-root-connections.ts +149 -149
  370. package/docs/03-PATTERN-GUIDES/multiple-connections/examples/real-world-scenarios.ts +405 -405
  371. package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-01-foundations.md +378 -378
  372. package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-02-quick-start.md +566 -566
  373. package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-03-targeting-connections.md +659 -659
  374. package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-04-parallel-queries.md +656 -656
  375. package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-05-best-practices.md +624 -624
  376. package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-06-api-reference.md +824 -824
  377. package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-06-versori.md +119 -119
  378. package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-07-api-reference.md +87 -87
  379. package/docs/03-PATTERN-GUIDES/multiple-connections/multiple-connections-quick-reference.md +353 -353
  380. package/docs/03-PATTERN-GUIDES/multiple-connections/multiple-connections-readme.md +270 -270
  381. package/docs/03-PATTERN-GUIDES/multiple-connections/readme.md +30 -30
  382. package/docs/03-PATTERN-GUIDES/pagination/pagination-readme.md +14 -14
  383. package/docs/03-PATTERN-GUIDES/pagination/readme.md +24 -24
  384. package/docs/03-PATTERN-GUIDES/parquet/examples/common-patterns.ts +180 -180
  385. package/docs/03-PATTERN-GUIDES/parquet/examples/read-parquet.ts +48 -48
  386. package/docs/03-PATTERN-GUIDES/parquet/examples/write-parquet.ts +65 -65
  387. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-01-introduction.md +393 -393
  388. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-02-quick-start.md +572 -572
  389. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-03-reading-parquet.md +525 -525
  390. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-04-writing-parquet.md +554 -554
  391. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-05-graphql-extraction.md +405 -405
  392. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-06-performance.md +104 -104
  393. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-06-s3-integration.md +511 -511
  394. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-07-api-reference.md +90 -90
  395. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-07-performance-optimization.md +525 -525
  396. package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-08-best-practices.md +712 -712
  397. package/docs/03-PATTERN-GUIDES/parquet/parquet-quick-reference.md +683 -683
  398. package/docs/03-PATTERN-GUIDES/parquet/parquet-readme.md +248 -248
  399. package/docs/03-PATTERN-GUIDES/parquet/readme.md +32 -32
  400. package/docs/03-PATTERN-GUIDES/parsers/parsers-readme.md +12 -12
  401. package/docs/03-PATTERN-GUIDES/parsers/readme.md +24 -24
  402. package/docs/03-PATTERN-GUIDES/readme.md +159 -159
  403. package/docs/03-PATTERN-GUIDES/webhooks/readme.md +24 -24
  404. package/docs/03-PATTERN-GUIDES/webhooks/webhooks-readme.md +8 -8
  405. package/docs/04-REFERENCE/architecture/architecture-01-overview.md +427 -427
  406. package/docs/04-REFERENCE/architecture/architecture-02-client-architecture.md +424 -424
  407. package/docs/04-REFERENCE/architecture/architecture-03-data-flow.md +690 -690
  408. package/docs/04-REFERENCE/architecture/architecture-04-service-layer.md +834 -834
  409. package/docs/04-REFERENCE/architecture/architecture-05-integration-architecture.md +655 -655
  410. package/docs/04-REFERENCE/architecture/architecture-06-state-management.md +653 -653
  411. package/docs/04-REFERENCE/architecture/architecture-adding-new-data-sources.md +686 -686
  412. package/docs/04-REFERENCE/architecture/readme.md +279 -279
  413. package/docs/04-REFERENCE/platforms/deno/readme.md +117 -117
  414. package/docs/04-REFERENCE/platforms/nodejs/readme.md +146 -146
  415. package/docs/04-REFERENCE/platforms/readme.md +135 -135
  416. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-01-introduction.md +398 -398
  417. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-02-quick-start.md +560 -560
  418. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-03-authentication.md +757 -757
  419. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-04-workflows.md +2476 -2476
  420. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-05-connections.md +1167 -1167
  421. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-06-kv-storage.md +990 -990
  422. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-06-state-management.md +121 -121
  423. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-07-api-reference.md +68 -68
  424. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-07-deployment.md +731 -731
  425. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-08-best-practices.md +1111 -1111
  426. package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-09-signature-reference.md +766 -766
  427. package/docs/04-REFERENCE/platforms/versori/platforms-versori-readme.md +299 -299
  428. package/docs/04-REFERENCE/platforms/versori/platforms-versori-s3-sftp-configuration-guide.md +1425 -1425
  429. package/docs/04-REFERENCE/platforms/versori/platforms-versori-webhook-api-key-security.md +816 -816
  430. package/docs/04-REFERENCE/platforms/versori/platforms-versori-webhook-connection-security.md +681 -681
  431. package/docs/04-REFERENCE/platforms/versori/platforms-versori-workflow-task-types.md +708 -708
  432. package/docs/04-REFERENCE/platforms/versori/readme.md +108 -108
  433. package/docs/04-REFERENCE/readme.md +148 -148
  434. package/docs/04-REFERENCE/resolver-signature/examples/advanced-resolvers.ts +482 -482
  435. package/docs/04-REFERENCE/resolver-signature/examples/async-resolvers.ts +496 -496
  436. package/docs/04-REFERENCE/resolver-signature/examples/basic-resolvers.ts +343 -343
  437. package/docs/04-REFERENCE/resolver-signature/examples/resolver-signature-readme.md +188 -188
  438. package/docs/04-REFERENCE/resolver-signature/examples/testing-resolvers.ts +463 -463
  439. package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-01-foundations.md +286 -286
  440. package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-02-parameter-reference.md +643 -643
  441. package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-03-basic-examples.md +521 -521
  442. package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-04-advanced-patterns.md +739 -739
  443. package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-05-sdk-resolvers.md +531 -531
  444. package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-06-migration-guide.md +650 -650
  445. package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-06-testing.md +125 -125
  446. package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-07-api-reference.md +794 -794
  447. package/docs/04-REFERENCE/resolver-signature/readme.md +64 -64
  448. package/docs/04-REFERENCE/resolver-signature/resolver-signature-quick-reference.md +270 -270
  449. package/docs/04-REFERENCE/resolver-signature/resolver-signature-readme.md +351 -351
  450. package/docs/04-REFERENCE/schema/fluent-commerce-schema.json +764 -764
  451. package/docs/04-REFERENCE/schema/readme.md +141 -141
  452. package/docs/04-REFERENCE/testing/examples/04-reference-testing-readme.md +158 -158
  453. package/docs/04-REFERENCE/testing/examples/fluent-testing.ts +62 -62
  454. package/docs/04-REFERENCE/testing/examples/health-check.ts +155 -155
  455. package/docs/04-REFERENCE/testing/examples/integration-test.ts +119 -119
  456. package/docs/04-REFERENCE/testing/examples/performance-test.ts +183 -183
  457. package/docs/04-REFERENCE/testing/examples/s3-testing.ts +127 -127
  458. package/docs/04-REFERENCE/testing/modules/04-reference-testing-01-foundations.md +267 -267
  459. package/docs/04-REFERENCE/testing/modules/04-reference-testing-02-s3-testing.md +599 -599
  460. package/docs/04-REFERENCE/testing/modules/04-reference-testing-03-fluent-testing.md +589 -589
  461. package/docs/04-REFERENCE/testing/modules/04-reference-testing-04-integration-testing.md +699 -699
  462. package/docs/04-REFERENCE/testing/modules/04-reference-testing-05-debugging.md +478 -478
  463. package/docs/04-REFERENCE/testing/modules/04-reference-testing-06-cicd-integration.md +463 -463
  464. package/docs/04-REFERENCE/testing/modules/04-reference-testing-06-preflight-validation.md +131 -131
  465. package/docs/04-REFERENCE/testing/modules/04-reference-testing-07-best-practices.md +499 -499
  466. package/docs/04-REFERENCE/testing/modules/04-reference-testing-07-coverage-ci.md +165 -165
  467. package/docs/04-REFERENCE/testing/modules/04-reference-testing-08-api-reference.md +634 -634
  468. package/docs/04-REFERENCE/testing/readme.md +86 -86
  469. package/docs/04-REFERENCE/testing/testing-quick-reference.md +667 -667
  470. package/docs/04-REFERENCE/testing/testing-readme.md +286 -286
  471. package/docs/04-REFERENCE/troubleshooting/readme.md +144 -144
  472. package/docs/04-REFERENCE/troubleshooting/troubleshooting-deno-sftp-compatibility.md +392 -392
  473. package/docs/template-loading-matrix.md +242 -242
  474. package/package.json +5 -3
  475. package/docs/02-CORE-GUIDES/api-reference/cli-profile-integration.md +0 -377
@@ -1,557 +1,557 @@
1
- # Module 10: Extraction
2
-
3
- **Level:** Intermediate to Advanced
4
- **Category:** Data Export & Integration
5
-
6
- ## Overview
7
-
8
- Extraction involves querying data from Fluent Commerce GraphQL API and exporting it to external systems in various formats (CSV, JSON, XML, Parquet). The SDK provides `ExtractionOrchestrator` for high-level extraction workflows with auto-pagination, format conversion, and S3 output.
9
-
10
- ## Table of Contents
11
-
12
- - [ExtractionOrchestrator Service](#extractionorchestrator-service)
13
- - [Format Conversion](#format-conversion)
14
- - [Partitioning Strategies](#partitioning-strategies)
15
- - [S3 Output](#s3-output)
16
- - [Auto-Pagination](#auto-pagination)
17
- - [Data Enrichment](#data-enrichment)
18
- - [Performance Optimization](#performance-optimization)
19
- - [Common Patterns](#common-patterns)
20
- - [Error Handling](#error-handling)
21
- - [Troubleshooting](#troubleshooting)
22
- - [See Also](#see-also)
23
-
24
- ---
25
-
26
- ## ExtractionOrchestrator Service
27
-
28
- High-level service for end-to-end extraction workflows:
29
-
30
- ```typescript
31
- import { createClient, ExtractionOrchestrator } from '@fluentcommerce/fc-connect-sdk';
32
-
33
- const client = await createClient({ config });
34
- const orchestrator = new ExtractionOrchestrator(client, console);
35
-
36
- // Extract virtual positions to CSV on S3
37
- const result = await orchestrator.extractToS3({
38
- query: `
39
- query GetPositions($first: Int, $after: String) {
40
- virtualPositions(first: $first, after: $after) {
41
- edges {
42
- node {
43
- id
44
- ref
45
- productRef
46
- groupRef
47
- quantity
48
- status
49
- }
50
- }
51
- pageInfo {
52
- hasNextPage
53
- endCursor
54
- }
55
- }
56
- }
57
- `,
58
- connectionName: 'virtualPositions', // GraphQL connection name
59
- outputFormat: 'csv', // csv | json | xml | parquet
60
- s3Config: {
61
- bucket: 'my-exports',
62
- keyPrefix: 'fluent/virtual-positions/',
63
- filename: `positions-${Date.now()}.csv`
64
- },
65
- pagination: {
66
- pageSize: 250,
67
- maxPages: Infinity
68
- }
69
- });
70
-
71
- console.log(`Extracted ${result.recordCount} records to ${result.s3Key}`);
72
- ```
73
-
74
- **Key Features:**
75
- - Automatic pagination through all results
76
- - Format conversion (JSON → CSV/XML/Parquet)
77
- - Direct S3 upload (no local disk)
78
- - Progress tracking and logging
79
- - Error recovery and retry
80
-
81
- ---
82
-
83
- ## Format Conversion
84
-
85
- The SDK supports multiple output formats:
86
-
87
- ### CSV Export
88
-
89
- ```typescript
90
- await orchestrator.extractToS3({
91
- query,
92
- connectionName: 'inventoryPositions',
93
- outputFormat: 'csv',
94
- s3Config: {
95
- bucket: 'exports',
96
- keyPrefix: 'inventory/',
97
- filename: 'positions.csv'
98
- },
99
- csvOptions: {
100
- headers: true, // Include header row
101
- delimiter: ',', // Column separator
102
- quote: '"', // Quote character
103
- includeNull: false // Skip null values
104
- }
105
- });
106
- ```
107
-
108
- **Output:**
109
- ```csv
110
- id,ref,productRef,locationRef,onHand,status
111
- 123,POS-001,SKU-100,LOC-A,50,ACTIVE
112
- 124,POS-002,SKU-101,LOC-B,25,ACTIVE
113
- ```
114
-
115
- ### JSON Export
116
-
117
- ```typescript
118
- await orchestrator.extractToS3({
119
- query,
120
- connectionName: 'orders',
121
- outputFormat: 'json',
122
- s3Config: {
123
- bucket: 'exports',
124
- keyPrefix: 'orders/',
125
- filename: 'orders.json'
126
- },
127
- jsonOptions: {
128
- pretty: true, // Pretty-print JSON
129
- arrayFormat: true // Output as JSON array
130
- }
131
- });
132
- ```
133
-
134
- **Output:**
135
- ```json
136
- [
137
- {
138
- "id": "123",
139
- "ref": "ORD-001",
140
- "status": "BOOKED",
141
- "totalPrice": 99.99
142
- },
143
- {
144
- "id": "124",
145
- "ref": "ORD-002",
146
- "status": "BOOKED",
147
- "totalPrice": 149.99
148
- }
149
- ]
150
- ```
151
-
152
- ### XML Export
153
-
154
- ```typescript
155
- await orchestrator.extractToS3({
156
- query,
157
- connectionName: 'products',
158
- outputFormat: 'xml',
159
- s3Config: {
160
- bucket: 'exports',
161
- keyPrefix: 'products/',
162
- filename: 'products.xml'
163
- },
164
- xmlOptions: {
165
- rootElement: 'Products', // Root element name
166
- itemElement: 'Product', // Individual record element
167
- declaration: true // Include <?xml declaration
168
- }
169
- });
170
- ```
171
-
172
- **Output:**
173
- ```xml
174
- <?xml version="1.0" encoding="UTF-8"?>
175
- <Products>
176
- <Product>
177
- <id>123</id>
178
- <ref>PROD-001</ref>
179
- <name>Widget</name>
180
- <status>ACTIVE</status>
181
- </Product>
182
- <Product>
183
- <id>124</id>
184
- <ref>PROD-002</ref>
185
- <name>Gadget</name>
186
- <status>ACTIVE</status>
187
- </Product>
188
- </Products>
189
- ```
190
-
191
- ### Parquet Export
192
-
193
- ```typescript
194
- await orchestrator.extractToS3({
195
- query,
196
- connectionName: 'virtualPositions',
197
- outputFormat: 'parquet',
198
- s3Config: {
199
- bucket: 'datalake',
200
- keyPrefix: 'fluent/positions/date=2025-01-15/',
201
- filename: 'positions.parquet'
202
- },
203
- parquetOptions: {
204
- compression: 'SNAPPY', // SNAPPY | GZIP | NONE
205
- rowGroupSize: 5000 // Records per row group
206
- }
207
- });
208
- ```
209
-
210
- ---
211
-
212
- ## Partitioning Strategies
213
-
214
- For large datasets, partition exports by date, location, or other dimensions:
215
-
216
- ### Date Partitioning
217
-
218
- ```typescript
219
- // Partition by extraction date (Hive-style)
220
- const today = new Date().toISOString().split('T')[0];
221
-
222
- await orchestrator.extractToS3({
223
- query,
224
- connectionName: 'orders',
225
- outputFormat: 'parquet',
226
- s3Config: {
227
- bucket: 'datalake',
228
- keyPrefix: `fluent/orders/date=${today}/`, // date=2025-01-15/
229
- filename: `orders-${Date.now()}.parquet`
230
- }
231
- });
232
- ```
233
-
234
- ### Multi-Dimensional Partitioning
235
-
236
- ```typescript
237
- // Partition by retailer + date
238
- const retailerId = process.env.FLUENT_RETAILER_ID;
239
- const today = new Date().toISOString().split('T')[0];
240
-
241
- await orchestrator.extractToS3({
242
- query,
243
- connectionName: 'virtualPositions',
244
- outputFormat: 'parquet',
245
- s3Config: {
246
- bucket: 'datalake',
247
- keyPrefix: `fluent/positions/retailer=${retailerId}/date=${today}/`,
248
- filename: `positions-${Date.now()}.parquet`
249
- }
250
- });
251
- ```
252
-
253
- ---
254
-
255
- ## S3 Output
256
-
257
- ### Direct S3 Upload
258
-
259
- The ExtractionOrchestrator streams directly to S3 without local disk:
260
-
261
- ```typescript
262
- await orchestrator.extractToS3({
263
- query,
264
- connectionName: 'inventoryPositions',
265
- outputFormat: 'csv',
266
- s3Config: {
267
- bucket: 'my-bucket',
268
- keyPrefix: 'exports/inventory/',
269
- filename: 'positions.csv',
270
- region: 'us-east-1', // AWS region
271
- acl: 'private' // S3 ACL
272
- },
273
- awsCredentials: {
274
- accessKeyId: process.env.AWS_ACCESS_KEY_ID,
275
- secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY
276
- }
277
- });
278
- ```
279
-
280
- ### S3 Path Construction
281
-
282
- ```typescript
283
- // Generates: s3://my-bucket/exports/inventory/positions.csv
284
- const s3Path = `s3://${s3Config.bucket}/${s3Config.keyPrefix}${s3Config.filename}`;
285
- ```
286
-
287
- ### Custom S3 Configuration
288
-
289
- ```typescript
290
- import { S3DataSource } from '@fluentcommerce/fc-connect-sdk';
291
-
292
- const s3 = new S3DataSource({
293
- type: 'S3_CSV',
294
- settings: {
295
- bucket: 'my-bucket',
296
- region: 'us-west-2',
297
- credentials: {
298
- accessKeyId: process.env.AWS_ACCESS_KEY_ID,
299
- secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY
300
- }
301
- }
302
- });
303
-
304
- // Manual upload
305
- await s3.writeFile('exports/data.csv', csvContent);
306
- ```
307
-
308
- ---
309
-
310
- ## Auto-Pagination
311
-
312
- ExtractionOrchestrator handles pagination automatically:
313
-
314
- ```typescript
315
- await orchestrator.extractToS3({
316
- query,
317
- connectionName: 'virtualPositions',
318
- outputFormat: 'csv',
319
- s3Config: { /* ... */ },
320
- pagination: {
321
- pageSize: 250, // Records per page
322
- maxPages: Infinity, // Extract all pages
323
- delayMs: 500 // Delay between pages (rate limiting)
324
- }
325
- });
326
- ```
327
-
328
- **Under the hood:**
329
- 1. Fetches first page (250 records)
330
- 2. Checks `pageInfo.hasNextPage`
331
- 3. If true, fetches next page with `endCursor`
332
- 4. Repeats until `hasNextPage: false`
333
- 5. Streams all records to S3
334
-
335
- ---
336
-
337
- ## Data Enrichment
338
-
339
- Transform records during extraction:
340
-
341
- ```typescript
342
- await orchestrator.extractToS3({
343
- query,
344
- connectionName: 'orders',
345
- outputFormat: 'csv',
346
- s3Config: { /* ... */ },
347
- transformFn: (record) => ({
348
- ...record,
349
- extractedAt: new Date().toISOString(),
350
- totalPriceUSD: record.totalPrice,
351
- currency: 'USD'
352
- })
353
- });
354
- ```
355
-
356
- **Use Cases:**
357
- - Add extraction timestamp
358
- - Compute derived fields
359
- - Normalize data formats
360
- - Filter sensitive fields
361
-
362
- ---
363
-
364
- ## Performance Optimization
365
-
366
- ### Parallel Extractions
367
-
368
- Extract multiple entities in parallel:
369
-
370
- ```typescript
371
- await Promise.all([
372
- orchestrator.extractToS3({ query: positionsQuery, connectionName: 'inventoryPositions', /* ... */ }),
373
- orchestrator.extractToS3({ query: ordersQuery, connectionName: 'orders', /* ... */ }),
374
- orchestrator.extractToS3({ query: productsQuery, connectionName: 'products', /* ... */ })
375
- ]);
376
- ```
377
-
378
- ### Streaming Large Datasets
379
-
380
- For 100K+ records, use streaming:
381
-
382
- ```typescript
383
- // ExtractionOrchestrator streams by default (no memory accumulation)
384
- await orchestrator.extractToS3({
385
- query,
386
- connectionName: 'virtualPositions',
387
- outputFormat: 'parquet',
388
- s3Config: { /* ... */ },
389
- pagination: {
390
- pageSize: 500, // Larger pages for throughput
391
- delayMs: 0 // No delay (maximize speed)
392
- }
393
- });
394
- ```
395
-
396
- ### Compression
397
-
398
- Reduce S3 storage costs with compression:
399
-
400
- ```typescript
401
- // Parquet with SNAPPY compression
402
- await orchestrator.extractToS3({
403
- query,
404
- connectionName: 'orders',
405
- outputFormat: 'parquet',
406
- s3Config: { /* ... */ },
407
- parquetOptions: {
408
- compression: 'SNAPPY' // 10-20x size reduction
409
- }
410
- });
411
- ```
412
-
413
- ---
414
-
415
- ## Common Patterns
416
-
417
- ### Pattern 1: Daily Extract Job
418
-
419
- ```typescript
420
- import { schedule } from '@versori/run';
421
- import { createClient, ExtractionOrchestrator } from '@fluentcommerce/fc-connect-sdk';
422
-
423
- export const dailyExtract = schedule('daily-extract', '0 2 * * *', async (ctx) => {
424
- const { log } = ctx;
425
- const client = await createClient({ ...ctx, log });
426
- const orchestrator = new ExtractionOrchestrator(client, log);
427
-
428
- const today = new Date().toISOString().split('T')[0];
429
-
430
- await orchestrator.extractToS3({
431
- query: virtualPositionsQuery,
432
- connectionName: 'virtualPositions',
433
- outputFormat: 'parquet',
434
- s3Config: {
435
- bucket: 'datalake',
436
- keyPrefix: `fluent/positions/date=${today}/`,
437
- filename: `positions-${Date.now()}.parquet`
438
- }
439
- });
440
-
441
- log.info('Daily extract complete');
442
- });
443
- ```
444
-
445
- ### Pattern 2: Multi-Format Export
446
-
447
- ```typescript
448
- async function exportAllFormats(client, query) {
449
- const orchestrator = new ExtractionOrchestrator(client, console);
450
-
451
- await Promise.all([
452
- // CSV for BI tools
453
- orchestrator.extractToS3({
454
- query,
455
- connectionName: 'orders',
456
- outputFormat: 'csv',
457
- s3Config: { bucket: 'exports', keyPrefix: 'csv/', filename: 'orders.csv' }
458
- }),
459
-
460
- // JSON for APIs
461
- orchestrator.extractToS3({
462
- query,
463
- connectionName: 'orders',
464
- outputFormat: 'json',
465
- s3Config: { bucket: 'exports', keyPrefix: 'json/', filename: 'orders.json' }
466
- }),
467
-
468
- // Parquet for data lake
469
- orchestrator.extractToS3({
470
- query,
471
- connectionName: 'orders',
472
- outputFormat: 'parquet',
473
- s3Config: { bucket: 'datalake', keyPrefix: 'orders/', filename: 'orders.parquet' }
474
- })
475
- ]);
476
- }
477
- ```
478
-
479
- ---
480
-
481
- ## Error Handling
482
-
483
- ```typescript
484
- try {
485
- const result = await orchestrator.extractToS3({
486
- query,
487
- connectionName: 'orders',
488
- outputFormat: 'csv',
489
- s3Config: { /* ... */ }
490
- });
491
-
492
- console.log(`Success: ${result.recordCount} records extracted`);
493
- } catch (error) {
494
- if (error.code === 'ECONNREFUSED') {
495
- console.error('Cannot connect to Fluent API');
496
- } else if (error.code === 'NoSuchBucket') {
497
- console.error('S3 bucket does not exist');
498
- } else if (error.message.includes('GraphQL')) {
499
- console.error('GraphQL query error:', error.message);
500
- } else {
501
- console.error('Extraction failed:', error);
502
- }
503
- }
504
- ```
505
-
506
- ---
507
-
508
- ## Troubleshooting
509
-
510
- ### Issue 1: Out of Memory
511
-
512
- **Symptom:** Process crashes with OOM error
513
-
514
- **Cause:** Accumulating too many records in memory
515
-
516
- **Solution:** ExtractionOrchestrator streams by default, but ensure pagination is enabled
517
-
518
- ### Issue 2: Slow Extraction
519
-
520
- **Symptom:** Takes hours to extract large dataset
521
-
522
- **Solution:** Increase page size and reduce delay
523
- ```typescript
524
- pagination: {
525
- pageSize: 500, // Larger pages
526
- delayMs: 0 // No delay
527
- }
528
- ```
529
-
530
- ### Issue 3: S3 Upload Fails
531
-
532
- **Symptom:** "Access Denied" or "NoSuchBucket" errors
533
-
534
- **Solution:** Verify AWS credentials and bucket permissions
535
-
536
- ---
537
-
538
- ## See Also
539
-
540
- **Related Modules:**
541
- - [Module 05: Services](./api-reference-05-services.md) - ExtractionOrchestrator details
542
- - [Module 06: Data Sources](./api-reference-06-data-sources.md) - S3DataSource
543
- - [Module 08: Pagination](./api-reference-08-pagination.md) - Auto-pagination
544
-
545
- **Complete Guides:**
546
- - [Extraction Guide](../../extraction/extraction-readme.md) - Complete extraction series
547
- - [Parquet Guide](../../../03-PATTERN-GUIDES/parquet/parquet-readme.md) - Parquet export patterns
548
-
549
- **Templates:**
550
- - [Extraction Templates](../../../01-TEMPLATES/versori/workflows/extraction/graphql-queries/) - Production examples
551
-
552
- ---
553
-
554
- **Navigation:**
555
- - [Back to Module List](./readme.md)
556
- - [Previous: Module 09 - Webhook Validation](./api-reference-09-webhook-validation.md)
557
- - [Next: Module 11 - Error Handling](./api-reference-11-error-handling.md)
1
+ # Module 10: Extraction
2
+
3
+ **Level:** Intermediate to Advanced
4
+ **Category:** Data Export & Integration
5
+
6
+ ## Overview
7
+
8
+ Extraction involves querying data from Fluent Commerce GraphQL API and exporting it to external systems in various formats (CSV, JSON, XML, Parquet). The SDK provides `ExtractionOrchestrator` for high-level extraction workflows with auto-pagination, format conversion, and S3 output.
9
+
10
+ ## Table of Contents
11
+
12
+ - [ExtractionOrchestrator Service](#extractionorchestrator-service)
13
+ - [Format Conversion](#format-conversion)
14
+ - [Partitioning Strategies](#partitioning-strategies)
15
+ - [S3 Output](#s3-output)
16
+ - [Auto-Pagination](#auto-pagination)
17
+ - [Data Enrichment](#data-enrichment)
18
+ - [Performance Optimization](#performance-optimization)
19
+ - [Common Patterns](#common-patterns)
20
+ - [Error Handling](#error-handling)
21
+ - [Troubleshooting](#troubleshooting)
22
+ - [See Also](#see-also)
23
+
24
+ ---
25
+
26
+ ## ExtractionOrchestrator Service
27
+
28
+ High-level service for end-to-end extraction workflows:
29
+
30
+ ```typescript
31
+ import { createClient, ExtractionOrchestrator } from '@fluentcommerce/fc-connect-sdk';
32
+
33
+ const client = await createClient({ config });
34
+ const orchestrator = new ExtractionOrchestrator(client, console);
35
+
36
+ // Extract virtual positions to CSV on S3
37
+ const result = await orchestrator.extractToS3({
38
+ query: `
39
+ query GetPositions($first: Int, $after: String) {
40
+ virtualPositions(first: $first, after: $after) {
41
+ edges {
42
+ node {
43
+ id
44
+ ref
45
+ productRef
46
+ groupRef
47
+ quantity
48
+ status
49
+ }
50
+ }
51
+ pageInfo {
52
+ hasNextPage
53
+ endCursor
54
+ }
55
+ }
56
+ }
57
+ `,
58
+ connectionName: 'virtualPositions', // GraphQL connection name
59
+ outputFormat: 'csv', // csv | json | xml | parquet
60
+ s3Config: {
61
+ bucket: 'my-exports',
62
+ keyPrefix: 'fluent/virtual-positions/',
63
+ filename: `positions-${Date.now()}.csv`
64
+ },
65
+ pagination: {
66
+ pageSize: 250,
67
+ maxPages: Infinity
68
+ }
69
+ });
70
+
71
+ console.log(`Extracted ${result.recordCount} records to ${result.s3Key}`);
72
+ ```
73
+
74
+ **Key Features:**
75
+ - Automatic pagination through all results
76
+ - Format conversion (JSON → CSV/XML/Parquet)
77
+ - Direct S3 upload (no local disk)
78
+ - Progress tracking and logging
79
+ - Error recovery and retry
80
+
81
+ ---
82
+
83
+ ## Format Conversion
84
+
85
+ The SDK supports multiple output formats:
86
+
87
+ ### CSV Export
88
+
89
+ ```typescript
90
+ await orchestrator.extractToS3({
91
+ query,
92
+ connectionName: 'inventoryPositions',
93
+ outputFormat: 'csv',
94
+ s3Config: {
95
+ bucket: 'exports',
96
+ keyPrefix: 'inventory/',
97
+ filename: 'positions.csv'
98
+ },
99
+ csvOptions: {
100
+ headers: true, // Include header row
101
+ delimiter: ',', // Column separator
102
+ quote: '"', // Quote character
103
+ includeNull: false // Skip null values
104
+ }
105
+ });
106
+ ```
107
+
108
+ **Output:**
109
+ ```csv
110
+ id,ref,productRef,locationRef,onHand,status
111
+ 123,POS-001,SKU-100,LOC-A,50,ACTIVE
112
+ 124,POS-002,SKU-101,LOC-B,25,ACTIVE
113
+ ```
114
+
115
+ ### JSON Export
116
+
117
+ ```typescript
118
+ await orchestrator.extractToS3({
119
+ query,
120
+ connectionName: 'orders',
121
+ outputFormat: 'json',
122
+ s3Config: {
123
+ bucket: 'exports',
124
+ keyPrefix: 'orders/',
125
+ filename: 'orders.json'
126
+ },
127
+ jsonOptions: {
128
+ pretty: true, // Pretty-print JSON
129
+ arrayFormat: true // Output as JSON array
130
+ }
131
+ });
132
+ ```
133
+
134
+ **Output:**
135
+ ```json
136
+ [
137
+ {
138
+ "id": "123",
139
+ "ref": "ORD-001",
140
+ "status": "BOOKED",
141
+ "totalPrice": 99.99
142
+ },
143
+ {
144
+ "id": "124",
145
+ "ref": "ORD-002",
146
+ "status": "BOOKED",
147
+ "totalPrice": 149.99
148
+ }
149
+ ]
150
+ ```
151
+
152
+ ### XML Export
153
+
154
+ ```typescript
155
+ await orchestrator.extractToS3({
156
+ query,
157
+ connectionName: 'products',
158
+ outputFormat: 'xml',
159
+ s3Config: {
160
+ bucket: 'exports',
161
+ keyPrefix: 'products/',
162
+ filename: 'products.xml'
163
+ },
164
+ xmlOptions: {
165
+ rootElement: 'Products', // Root element name
166
+ itemElement: 'Product', // Individual record element
167
+ declaration: true // Include <?xml declaration
168
+ }
169
+ });
170
+ ```
171
+
172
+ **Output:**
173
+ ```xml
174
+ <?xml version="1.0" encoding="UTF-8"?>
175
+ <Products>
176
+ <Product>
177
+ <id>123</id>
178
+ <ref>PROD-001</ref>
179
+ <name>Widget</name>
180
+ <status>ACTIVE</status>
181
+ </Product>
182
+ <Product>
183
+ <id>124</id>
184
+ <ref>PROD-002</ref>
185
+ <name>Gadget</name>
186
+ <status>ACTIVE</status>
187
+ </Product>
188
+ </Products>
189
+ ```
190
+
191
+ ### Parquet Export
192
+
193
+ ```typescript
194
+ await orchestrator.extractToS3({
195
+ query,
196
+ connectionName: 'virtualPositions',
197
+ outputFormat: 'parquet',
198
+ s3Config: {
199
+ bucket: 'datalake',
200
+ keyPrefix: 'fluent/positions/date=2025-01-15/',
201
+ filename: 'positions.parquet'
202
+ },
203
+ parquetOptions: {
204
+ compression: 'SNAPPY', // SNAPPY | GZIP | NONE
205
+ rowGroupSize: 5000 // Records per row group
206
+ }
207
+ });
208
+ ```
209
+
210
+ ---
211
+
212
+ ## Partitioning Strategies
213
+
214
+ For large datasets, partition exports by date, location, or other dimensions:
215
+
216
+ ### Date Partitioning
217
+
218
+ ```typescript
219
+ // Partition by extraction date (Hive-style)
220
+ const today = new Date().toISOString().split('T')[0];
221
+
222
+ await orchestrator.extractToS3({
223
+ query,
224
+ connectionName: 'orders',
225
+ outputFormat: 'parquet',
226
+ s3Config: {
227
+ bucket: 'datalake',
228
+ keyPrefix: `fluent/orders/date=${today}/`, // date=2025-01-15/
229
+ filename: `orders-${Date.now()}.parquet`
230
+ }
231
+ });
232
+ ```
233
+
234
+ ### Multi-Dimensional Partitioning
235
+
236
+ ```typescript
237
+ // Partition by retailer + date
238
+ const retailerId = process.env.FLUENT_RETAILER_ID;
239
+ const today = new Date().toISOString().split('T')[0];
240
+
241
+ await orchestrator.extractToS3({
242
+ query,
243
+ connectionName: 'virtualPositions',
244
+ outputFormat: 'parquet',
245
+ s3Config: {
246
+ bucket: 'datalake',
247
+ keyPrefix: `fluent/positions/retailer=${retailerId}/date=${today}/`,
248
+ filename: `positions-${Date.now()}.parquet`
249
+ }
250
+ });
251
+ ```
252
+
253
+ ---
254
+
255
+ ## S3 Output
256
+
257
+ ### Direct S3 Upload
258
+
259
+ The ExtractionOrchestrator streams directly to S3 without local disk:
260
+
261
+ ```typescript
262
+ await orchestrator.extractToS3({
263
+ query,
264
+ connectionName: 'inventoryPositions',
265
+ outputFormat: 'csv',
266
+ s3Config: {
267
+ bucket: 'my-bucket',
268
+ keyPrefix: 'exports/inventory/',
269
+ filename: 'positions.csv',
270
+ region: 'us-east-1', // AWS region
271
+ acl: 'private' // S3 ACL
272
+ },
273
+ awsCredentials: {
274
+ accessKeyId: process.env.AWS_ACCESS_KEY_ID,
275
+ secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY
276
+ }
277
+ });
278
+ ```
279
+
280
+ ### S3 Path Construction
281
+
282
+ ```typescript
283
+ // Generates: s3://my-bucket/exports/inventory/positions.csv
284
+ const s3Path = `s3://${s3Config.bucket}/${s3Config.keyPrefix}${s3Config.filename}`;
285
+ ```
286
+
287
+ ### Custom S3 Configuration
288
+
289
+ ```typescript
290
+ import { S3DataSource } from '@fluentcommerce/fc-connect-sdk';
291
+
292
+ const s3 = new S3DataSource({
293
+ type: 'S3_CSV',
294
+ settings: {
295
+ bucket: 'my-bucket',
296
+ region: 'us-west-2',
297
+ credentials: {
298
+ accessKeyId: process.env.AWS_ACCESS_KEY_ID,
299
+ secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY
300
+ }
301
+ }
302
+ });
303
+
304
+ // Manual upload
305
+ await s3.writeFile('exports/data.csv', csvContent);
306
+ ```
307
+
308
+ ---
309
+
310
+ ## Auto-Pagination
311
+
312
+ ExtractionOrchestrator handles pagination automatically:
313
+
314
+ ```typescript
315
+ await orchestrator.extractToS3({
316
+ query,
317
+ connectionName: 'virtualPositions',
318
+ outputFormat: 'csv',
319
+ s3Config: { /* ... */ },
320
+ pagination: {
321
+ pageSize: 250, // Records per page
322
+ maxPages: Infinity, // Extract all pages
323
+ delayMs: 500 // Delay between pages (rate limiting)
324
+ }
325
+ });
326
+ ```
327
+
328
+ **Under the hood:**
329
+ 1. Fetches first page (250 records)
330
+ 2. Checks `pageInfo.hasNextPage`
331
+ 3. If true, fetches next page with `endCursor`
332
+ 4. Repeats until `hasNextPage: false`
333
+ 5. Streams all records to S3
334
+
335
+ ---
336
+
337
+ ## Data Enrichment
338
+
339
+ Transform records during extraction:
340
+
341
+ ```typescript
342
+ await orchestrator.extractToS3({
343
+ query,
344
+ connectionName: 'orders',
345
+ outputFormat: 'csv',
346
+ s3Config: { /* ... */ },
347
+ transformFn: (record) => ({
348
+ ...record,
349
+ extractedAt: new Date().toISOString(),
350
+ totalPriceUSD: record.totalPrice,
351
+ currency: 'USD'
352
+ })
353
+ });
354
+ ```
355
+
356
+ **Use Cases:**
357
+ - Add extraction timestamp
358
+ - Compute derived fields
359
+ - Normalize data formats
360
+ - Filter sensitive fields
361
+
362
+ ---
363
+
364
+ ## Performance Optimization
365
+
366
+ ### Parallel Extractions
367
+
368
+ Extract multiple entities in parallel:
369
+
370
+ ```typescript
371
+ await Promise.all([
372
+ orchestrator.extractToS3({ query: positionsQuery, connectionName: 'inventoryPositions', /* ... */ }),
373
+ orchestrator.extractToS3({ query: ordersQuery, connectionName: 'orders', /* ... */ }),
374
+ orchestrator.extractToS3({ query: productsQuery, connectionName: 'products', /* ... */ })
375
+ ]);
376
+ ```
377
+
378
+ ### Streaming Large Datasets
379
+
380
+ For 100K+ records, use streaming:
381
+
382
+ ```typescript
383
+ // ExtractionOrchestrator streams by default (no memory accumulation)
384
+ await orchestrator.extractToS3({
385
+ query,
386
+ connectionName: 'virtualPositions',
387
+ outputFormat: 'parquet',
388
+ s3Config: { /* ... */ },
389
+ pagination: {
390
+ pageSize: 500, // Larger pages for throughput
391
+ delayMs: 0 // No delay (maximize speed)
392
+ }
393
+ });
394
+ ```
395
+
396
+ ### Compression
397
+
398
+ Reduce S3 storage costs with compression:
399
+
400
+ ```typescript
401
+ // Parquet with SNAPPY compression
402
+ await orchestrator.extractToS3({
403
+ query,
404
+ connectionName: 'orders',
405
+ outputFormat: 'parquet',
406
+ s3Config: { /* ... */ },
407
+ parquetOptions: {
408
+ compression: 'SNAPPY' // 10-20x size reduction
409
+ }
410
+ });
411
+ ```
412
+
413
+ ---
414
+
415
+ ## Common Patterns
416
+
417
+ ### Pattern 1: Daily Extract Job
418
+
419
+ ```typescript
420
+ import { schedule } from '@versori/run';
421
+ import { createClient, ExtractionOrchestrator } from '@fluentcommerce/fc-connect-sdk';
422
+
423
+ export const dailyExtract = schedule('daily-extract', '0 2 * * *', async (ctx) => {
424
+ const { log } = ctx;
425
+ const client = await createClient({ ...ctx, log });
426
+ const orchestrator = new ExtractionOrchestrator(client, log);
427
+
428
+ const today = new Date().toISOString().split('T')[0];
429
+
430
+ await orchestrator.extractToS3({
431
+ query: virtualPositionsQuery,
432
+ connectionName: 'virtualPositions',
433
+ outputFormat: 'parquet',
434
+ s3Config: {
435
+ bucket: 'datalake',
436
+ keyPrefix: `fluent/positions/date=${today}/`,
437
+ filename: `positions-${Date.now()}.parquet`
438
+ }
439
+ });
440
+
441
+ log.info('Daily extract complete');
442
+ });
443
+ ```
444
+
445
+ ### Pattern 2: Multi-Format Export
446
+
447
+ ```typescript
448
+ async function exportAllFormats(client, query) {
449
+ const orchestrator = new ExtractionOrchestrator(client, console);
450
+
451
+ await Promise.all([
452
+ // CSV for BI tools
453
+ orchestrator.extractToS3({
454
+ query,
455
+ connectionName: 'orders',
456
+ outputFormat: 'csv',
457
+ s3Config: { bucket: 'exports', keyPrefix: 'csv/', filename: 'orders.csv' }
458
+ }),
459
+
460
+ // JSON for APIs
461
+ orchestrator.extractToS3({
462
+ query,
463
+ connectionName: 'orders',
464
+ outputFormat: 'json',
465
+ s3Config: { bucket: 'exports', keyPrefix: 'json/', filename: 'orders.json' }
466
+ }),
467
+
468
+ // Parquet for data lake
469
+ orchestrator.extractToS3({
470
+ query,
471
+ connectionName: 'orders',
472
+ outputFormat: 'parquet',
473
+ s3Config: { bucket: 'datalake', keyPrefix: 'orders/', filename: 'orders.parquet' }
474
+ })
475
+ ]);
476
+ }
477
+ ```
478
+
479
+ ---
480
+
481
+ ## Error Handling
482
+
483
+ ```typescript
484
+ try {
485
+ const result = await orchestrator.extractToS3({
486
+ query,
487
+ connectionName: 'orders',
488
+ outputFormat: 'csv',
489
+ s3Config: { /* ... */ }
490
+ });
491
+
492
+ console.log(`Success: ${result.recordCount} records extracted`);
493
+ } catch (error) {
494
+ if (error.code === 'ECONNREFUSED') {
495
+ console.error('Cannot connect to Fluent API');
496
+ } else if (error.code === 'NoSuchBucket') {
497
+ console.error('S3 bucket does not exist');
498
+ } else if (error.message.includes('GraphQL')) {
499
+ console.error('GraphQL query error:', error.message);
500
+ } else {
501
+ console.error('Extraction failed:', error);
502
+ }
503
+ }
504
+ ```
505
+
506
+ ---
507
+
508
+ ## Troubleshooting
509
+
510
+ ### Issue 1: Out of Memory
511
+
512
+ **Symptom:** Process crashes with OOM error
513
+
514
+ **Cause:** Accumulating too many records in memory
515
+
516
+ **Solution:** ExtractionOrchestrator streams by default, but ensure pagination is enabled
517
+
518
+ ### Issue 2: Slow Extraction
519
+
520
+ **Symptom:** Takes hours to extract large dataset
521
+
522
+ **Solution:** Increase page size and reduce delay
523
+ ```typescript
524
+ pagination: {
525
+ pageSize: 500, // Larger pages
526
+ delayMs: 0 // No delay
527
+ }
528
+ ```
529
+
530
+ ### Issue 3: S3 Upload Fails
531
+
532
+ **Symptom:** "Access Denied" or "NoSuchBucket" errors
533
+
534
+ **Solution:** Verify AWS credentials and bucket permissions
535
+
536
+ ---
537
+
538
+ ## See Also
539
+
540
+ **Related Modules:**
541
+ - [Module 05: Services](./api-reference-05-services.md) - ExtractionOrchestrator details
542
+ - [Module 06: Data Sources](./api-reference-06-data-sources.md) - S3DataSource
543
+ - [Module 08: Pagination](./api-reference-08-pagination.md) - Auto-pagination
544
+
545
+ **Complete Guides:**
546
+ - [Extraction Guide](../../extraction/extraction-readme.md) - Complete extraction series
547
+ - [Parquet Guide](../../../03-PATTERN-GUIDES/parquet/parquet-readme.md) - Parquet export patterns
548
+
549
+ **Templates:**
550
+ - [Extraction Templates](../../../01-TEMPLATES/versori/workflows/extraction/graphql-queries/) - Production examples
551
+
552
+ ---
553
+
554
+ **Navigation:**
555
+ - [Back to Module List](./readme.md)
556
+ - [Previous: Module 09 - Webhook Validation](./api-reference-09-webhook-validation.md)
557
+ - [Next: Module 11 - Error Handling](./api-reference-11-error-handling.md)