@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.
- package/CHANGELOG.md +12 -0
- package/README.md +11 -0
- package/dist/cjs/clients/fluent-client.js +13 -6
- package/dist/cjs/utils/pagination-helpers.js +38 -2
- package/dist/cjs/versori/fluent-versori-client.js +11 -5
- package/dist/esm/clients/fluent-client.js +13 -6
- package/dist/esm/utils/pagination-helpers.js +38 -2
- package/dist/esm/versori/fluent-versori-client.js +11 -5
- package/dist/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/tsconfig.types.tsbuildinfo +1 -1
- package/docs/00-START-HERE/EXPORT-VALIDATION.md +158 -158
- package/docs/00-START-HERE/cli-analyze-source-structure-guide.md +655 -655
- package/docs/00-START-HERE/cli-documentation-index.md +202 -202
- package/docs/00-START-HERE/cli-quick-reference.md +252 -252
- package/docs/00-START-HERE/decision-tree.md +552 -552
- package/docs/00-START-HERE/getting-started.md +1070 -1070
- package/docs/00-START-HERE/mapper-quick-decision-guide.md +235 -235
- package/docs/00-START-HERE/readme.md +237 -237
- package/docs/00-START-HERE/retailerid-configuration.md +404 -404
- package/docs/00-START-HERE/sdk-philosophy.md +794 -794
- package/docs/00-START-HERE/troubleshooting-quick-reference.md +1086 -1086
- package/docs/01-TEMPLATES/faq.md +686 -686
- package/docs/01-TEMPLATES/patterns/pattern-templates-guide.md +68 -68
- package/docs/01-TEMPLATES/patterns/patterns-csv-schema-validation-and-rejection-report.md +233 -233
- package/docs/01-TEMPLATES/patterns/patterns-custom-resolvers.md +407 -407
- package/docs/01-TEMPLATES/patterns/patterns-error-handling-retry.md +511 -511
- package/docs/01-TEMPLATES/patterns/patterns-field-mapping-universal.md +701 -701
- package/docs/01-TEMPLATES/patterns/patterns-large-file-splitting.md +1430 -1430
- package/docs/01-TEMPLATES/patterns/patterns-master-data-etl.md +2399 -2399
- package/docs/01-TEMPLATES/patterns/patterns-pagination-streaming.md +447 -447
- package/docs/01-TEMPLATES/patterns/patterns-state-duplicate-prevention.md +385 -385
- package/docs/01-TEMPLATES/readme.md +957 -957
- package/docs/01-TEMPLATES/standalone/standalone-asn-inbound-processing.md +1209 -1209
- package/docs/01-TEMPLATES/standalone/standalone-graphql-query-export.md +1140 -1140
- package/docs/01-TEMPLATES/standalone/standalone-graphql-to-parquet-partitioned-s3.md +432 -432
- package/docs/01-TEMPLATES/standalone/standalone-multi-channel-inventory-sync.md +1185 -1185
- package/docs/01-TEMPLATES/standalone/standalone-multi-source-aggregation.md +1462 -1462
- package/docs/01-TEMPLATES/standalone/standalone-s3-csv-batch-api.md +1390 -1390
- package/docs/01-TEMPLATES/standalone/standalone-s3-csv-inventory-to-batch.md +330 -330
- package/docs/01-TEMPLATES/standalone/standalone-scripts-guide.md +87 -87
- package/docs/01-TEMPLATES/standalone/standalone-sftp-xml-graphql.md +1444 -1444
- package/docs/01-TEMPLATES/standalone/standalone-webhook-payload-processing.md +688 -688
- package/docs/01-TEMPLATES/versori/business-examples/business-examples-dropship-order-routing.md +193 -193
- package/docs/01-TEMPLATES/versori/business-examples/business-examples-graphql-parquet-extraction.md +518 -518
- package/docs/01-TEMPLATES/versori/business-examples/business-examples-inter-location-transfers.md +2162 -2162
- package/docs/01-TEMPLATES/versori/business-examples/business-examples-pre-order-allocation.md +2226 -2226
- package/docs/01-TEMPLATES/versori/business-examples/business-scenarios-guide.md +87 -87
- package/docs/01-TEMPLATES/versori/patterns/versori-patterns-connection-validation-pattern.md +656 -656
- package/docs/01-TEMPLATES/versori/patterns/versori-patterns-dual-workflow-connector.md +835 -835
- package/docs/01-TEMPLATES/versori/patterns/versori-patterns-guide.md +108 -108
- package/docs/01-TEMPLATES/versori/patterns/versori-patterns-kv-state-management.md +1533 -1533
- package/docs/01-TEMPLATES/versori/patterns/versori-patterns-xml-response-patterns.md +1160 -1160
- package/docs/01-TEMPLATES/versori/versori-platform-guide.md +201 -201
- package/docs/01-TEMPLATES/versori/webhooks/template-webhook-asn-purchase-order.md +1906 -1906
- package/docs/01-TEMPLATES/versori/webhooks/template-webhook-dropship-routing.md +1074 -1074
- package/docs/01-TEMPLATES/versori/webhooks/template-webhook-flash-sale-reserve.md +1395 -1395
- package/docs/01-TEMPLATES/versori/webhooks/template-webhook-generic-xml-order.md +888 -888
- package/docs/01-TEMPLATES/versori/webhooks/template-webhook-payment-gateway-integration.md +2478 -2478
- package/docs/01-TEMPLATES/versori/webhooks/template-webhook-rma-returns-comprehensive.md +2240 -2240
- package/docs/01-TEMPLATES/versori/webhooks/template-webhook-xml-order-ingestion.md +2029 -2029
- package/docs/01-TEMPLATES/versori/webhooks/webhook-templates-guide.md +140 -140
- package/docs/01-TEMPLATES/versori/workflows/_examples/sample-data/inventory-mapping.json +20 -20
- package/docs/01-TEMPLATES/versori/workflows/_examples/sample-data/products_2025-01-22.csv +11 -11
- package/docs/01-TEMPLATES/versori/workflows/_examples/sample-data/sample-data-guide.md +34 -34
- package/docs/01-TEMPLATES/versori/workflows/_examples/workflow-examples-guide.md +36 -36
- package/docs/01-TEMPLATES/versori/workflows/extraction/extraction-modes-guide.md +1038 -1038
- package/docs/01-TEMPLATES/versori/workflows/extraction/extraction-workflows-guide.md +138 -138
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/graphql-extraction-guide.md +63 -63
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-fulfillments-to-sftp-csv.md +2062 -2062
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-fulfillments-to-sftp-xml.md +2294 -2294
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-inventory-positions-to-s3-csv.md +2461 -2461
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-inventory-positions-to-sftp-xml.md +2529 -2529
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-inventory-quantities-to-s3-csv.md +2464 -2464
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-inventory-quantities-to-s3-json.md +1959 -1959
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-orders-to-s3-csv.md +1953 -1953
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-orders-to-sftp-xml.md +2541 -2541
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-products-to-s3-json.md +2384 -2384
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-products-to-sftp-xml.md +2445 -2445
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-virtual-positions-to-s3-csv.md +2355 -2355
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-virtual-positions-to-s3-json.md +2042 -2042
- package/docs/01-TEMPLATES/versori/workflows/extraction/graphql-queries/template-extraction-virtual-positions-to-sftp-xml.md +2726 -2726
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/batch-api-guide.md +206 -206
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-cycle-count-reconciliation.md +2030 -2030
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-multi-channel-inventory-sync.md +1882 -1882
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-s3-csv-inventory-batch.md +2827 -2827
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-s3-json-inventory-batch.md +1952 -1952
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-s3-xml-inventory-batch.md +3289 -3289
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-sftp-csv-inventory-batch.md +3064 -3064
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-sftp-json-inventory-batch.md +3238 -3238
- package/docs/01-TEMPLATES/versori/workflows/ingestion/batch-api/template-ingestion-sftp-xml-inventory-batch.md +2977 -2977
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/event-api-guide.md +321 -321
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-payload-json-order-cancel-event.md +959 -959
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-payload-xml-order-cancel-event.md +1170 -1170
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-s3-csv-product-event.md +2312 -2312
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-s3-json-product-event.md +2999 -2999
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-s3-parquet-product-event.md +2836 -2836
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-s3-xml-product-event.md +2395 -2395
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-sftp-csv-product-event.md +2295 -2295
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-sftp-json-product-event.md +2602 -2602
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-sftp-parquet-product-event.md +2589 -2589
- package/docs/01-TEMPLATES/versori/workflows/ingestion/event-api/template-ingestion-sftp-xml-product-event.md +3578 -3578
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/graphql-mutations-guide.md +93 -93
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-payload-json-order-update-graphql.md +1260 -1260
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-payload-xml-order-update-graphql.md +1472 -1472
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-csv-control-graphql.md +2417 -2417
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-csv-location-graphql.md +2811 -2811
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-csv-price-graphql.md +2619 -2619
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-json-location-graphql.md +2807 -2807
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-s3-xml-location-graphql.md +2373 -2373
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-sftp-csv-control-graphql.md +2740 -2740
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-sftp-csv-location-graphql.md +2760 -2760
- package/docs/01-TEMPLATES/versori/workflows/ingestion/graphql-mutations/template-ingestion-sftp-json-location-graphql.md +1710 -1710
- package/docs/01-TEMPLATES/versori/workflows/ingestion/ingestion-workflows-guide.md +136 -136
- package/docs/01-TEMPLATES/versori/workflows/rubix-webhooks/rubix-webhooks-guide.md +520 -520
- package/docs/01-TEMPLATES/versori/workflows/rubix-webhooks/template-webhook-rubix-fulfilment-to-sftp-xml-inline.md +1418 -1418
- package/docs/01-TEMPLATES/versori/workflows/rubix-webhooks/template-webhook-rubix-fulfilment-to-sftp-xml-universal-mapper.md +1785 -1785
- package/docs/01-TEMPLATES/versori/workflows/rubix-webhooks/template-webhook-rubix-order-attribute-update.md +824 -824
- package/docs/01-TEMPLATES/versori/workflows/workflows-overview-guide.md +646 -646
- package/docs/02-CORE-GUIDES/advanced-services/advanced-services-batch-archival.md +724 -724
- package/docs/02-CORE-GUIDES/advanced-services/advanced-services-job-tracker.md +627 -627
- package/docs/02-CORE-GUIDES/advanced-services/advanced-services-partial-batch-recovery.md +561 -561
- package/docs/02-CORE-GUIDES/advanced-services/advanced-services-quick-reference.md +367 -367
- package/docs/02-CORE-GUIDES/advanced-services/advanced-services-readme.md +407 -407
- package/docs/02-CORE-GUIDES/advanced-services/readme.md +49 -49
- package/docs/02-CORE-GUIDES/api-reference/api-reference-quick-reference.md +548 -548
- package/docs/02-CORE-GUIDES/api-reference/event-api-input-output-reference.md +702 -1171
- package/docs/02-CORE-GUIDES/api-reference/examples/client-initialization.ts +286 -286
- package/docs/02-CORE-GUIDES/api-reference/graphql-error-classification.md +337 -337
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-01-client-api.md +399 -520
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-03-authentication.md +199 -199
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-04-graphql-mapping.md +925 -925
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-05-services.md +1198 -1198
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-06-data-sources.md +1083 -1083
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-07-parsers.md +1097 -1097
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-08-pagination.md +513 -513
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-08-types.md +545 -597
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-09-error-handling.md +527 -527
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-09-webhook-validation.md +514 -514
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-10-extraction.md +557 -557
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-10-utilities.md +412 -412
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-11-cli-tools.md +423 -423
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-11-error-handling.md +716 -716
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-12-analyze-source-structure.md +518 -518
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-12-partial-responses.md +212 -212
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-12-testing.md +300 -300
- package/docs/02-CORE-GUIDES/api-reference/modules/api-reference-13-resolver-builder.md +322 -322
- package/docs/02-CORE-GUIDES/api-reference/readme.md +279 -279
- package/docs/02-CORE-GUIDES/auto-pagination/auto-pagination-quick-reference.md +351 -351
- package/docs/02-CORE-GUIDES/auto-pagination/auto-pagination-readme.md +277 -277
- package/docs/02-CORE-GUIDES/auto-pagination/examples/auto-pagination-readme.md +178 -178
- package/docs/02-CORE-GUIDES/auto-pagination/examples/common-patterns.ts +351 -351
- package/docs/02-CORE-GUIDES/auto-pagination/examples/paginate-products.ts +384 -384
- package/docs/02-CORE-GUIDES/auto-pagination/examples/paginate-virtual-positions.ts +308 -308
- package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-01-foundations.md +470 -470
- package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-02-quick-start.md +713 -713
- package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-03-configuration.md +754 -754
- package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-04-advanced-patterns.md +732 -732
- package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-05-sdk-integration.md +847 -847
- package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-06-troubleshooting.md +359 -359
- package/docs/02-CORE-GUIDES/auto-pagination/modules/auto-pagination-07-api-reference.md +462 -462
- package/docs/02-CORE-GUIDES/auto-pagination/readme.md +54 -54
- package/docs/02-CORE-GUIDES/data-sources/data-sources-file-operations-error-handling.md +1487 -1487
- package/docs/02-CORE-GUIDES/data-sources/data-sources-quick-reference.md +836 -836
- package/docs/02-CORE-GUIDES/data-sources/data-sources-readme.md +276 -276
- package/docs/02-CORE-GUIDES/data-sources/data-sources-sftp-credential-access-security.md +553 -553
- package/docs/02-CORE-GUIDES/data-sources/examples/common-patterns.ts +409 -409
- package/docs/02-CORE-GUIDES/data-sources/examples/data-sources-readme.md +178 -178
- package/docs/02-CORE-GUIDES/data-sources/examples/s3-operations.ts +308 -308
- package/docs/02-CORE-GUIDES/data-sources/examples/sftp-operations.ts +371 -371
- package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-01-foundations.md +735 -735
- package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-02-s3-operations.md +1302 -1302
- package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-03-sftp-operations.md +1379 -1379
- package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-04-file-patterns.md +941 -941
- package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-05-advanced-topics.md +813 -813
- package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-06-integration-patterns.md +486 -486
- package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-07-troubleshooting.md +387 -387
- package/docs/02-CORE-GUIDES/data-sources/modules/data-sources-08-api-reference.md +417 -417
- package/docs/02-CORE-GUIDES/data-sources/readme.md +77 -77
- package/docs/02-CORE-GUIDES/error-handling-guide.md +936 -936
- package/docs/02-CORE-GUIDES/extraction/examples/02-core-guides-extraction-readme.md +116 -116
- package/docs/02-CORE-GUIDES/extraction/examples/common-patterns.ts +428 -428
- package/docs/02-CORE-GUIDES/extraction/examples/extract-inventory-basic.ts +187 -187
- package/docs/02-CORE-GUIDES/extraction/extraction-quick-reference.md +596 -596
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-01-foundations.md +514 -514
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-02-basic-extraction.md +823 -823
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-03-parquet-processing.md +507 -507
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-04-data-enrichment.md +546 -546
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-05-transformation.md +494 -494
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-06-export-formats.md +458 -458
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-06-performance.md +138 -138
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-07-api-reference.md +148 -148
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-07-optimization.md +692 -692
- package/docs/02-CORE-GUIDES/extraction/modules/02-core-guides-extraction-08-extraction-orchestrator.md +1008 -1008
- package/docs/02-CORE-GUIDES/extraction/readme.md +151 -151
- package/docs/02-CORE-GUIDES/ingestion/examples/_simple-kv-store.ts +40 -40
- package/docs/02-CORE-GUIDES/ingestion/examples/error-recovery.ts +728 -728
- package/docs/02-CORE-GUIDES/ingestion/examples/event-driven.ts +501 -501
- package/docs/02-CORE-GUIDES/ingestion/examples/local-file-ingestion.ts +88 -88
- package/docs/02-CORE-GUIDES/ingestion/examples/parquet-ingestion.ts +117 -117
- package/docs/02-CORE-GUIDES/ingestion/examples/performance-optimized.ts +647 -647
- package/docs/02-CORE-GUIDES/ingestion/examples/s3-csv-ingestion.ts +169 -169
- package/docs/02-CORE-GUIDES/ingestion/examples/sftp-csv-ingestion.ts +134 -134
- package/docs/02-CORE-GUIDES/ingestion/ingestion-quick-reference.md +546 -546
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-01-introduction.md +626 -626
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-02-quick-start.md +658 -658
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-03-data-sources.md +1052 -1052
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-04-field-mapping.md +763 -763
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-05-advanced-parsers.md +676 -676
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-06-batch-api.md +1295 -1295
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-07-api-reference.md +138 -138
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-07-state-management.md +1037 -1037
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-08-performance-optimization.md +1349 -1349
- package/docs/02-CORE-GUIDES/ingestion/modules/02-core-guides-ingestion-09-best-practices.md +1893 -1893
- package/docs/02-CORE-GUIDES/ingestion/readme.md +160 -160
- package/docs/02-CORE-GUIDES/logging-guide.md +585 -585
- package/docs/02-CORE-GUIDES/mapping/error-handling-patterns.md +401 -401
- package/docs/02-CORE-GUIDES/mapping/examples/02-core-guides-mapping-readme.md +128 -128
- package/docs/02-CORE-GUIDES/mapping/examples/common-patterns.ts +273 -273
- package/docs/02-CORE-GUIDES/mapping/examples/csv-location-ingestion.json +36 -36
- package/docs/02-CORE-GUIDES/mapping/examples/csv-mapping.ts +242 -242
- package/docs/02-CORE-GUIDES/mapping/examples/graphql-to-parquet-extraction.json +36 -36
- package/docs/02-CORE-GUIDES/mapping/examples/json-mapping.ts +213 -213
- package/docs/02-CORE-GUIDES/mapping/examples/json-product-to-mutation.json +48 -48
- package/docs/02-CORE-GUIDES/mapping/examples/xml-mapping.ts +291 -291
- package/docs/02-CORE-GUIDES/mapping/examples/xml-order-to-mutation.json +45 -45
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/graphql-mutation-mapping-quick-reference.md +463 -463
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/graphql-mutation-mapping-readme.md +227 -227
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-01-introduction.md +222 -222
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-02-quick-start.md +351 -351
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-03-schema-validation.md +569 -569
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-04-mapping-patterns.md +471 -471
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-05-configuration-reference.md +611 -611
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-06-advanced-xpath.md +148 -148
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-06-path-syntax.md +464 -464
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-07-api-reference.md +94 -94
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-07-array-handling.md +307 -307
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-08-custom-resolvers.md +544 -544
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-09-advanced-patterns.md +427 -427
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-10-hooks-and-variables.md +336 -336
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-11-error-handling.md +488 -488
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-12-arguments-vs-nodes.md +383 -383
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/modules/graphql-mutation-mapping-13-best-practices.md +477 -477
- package/docs/02-CORE-GUIDES/mapping/graphql-mutation-mapping/readme.md +62 -62
- package/docs/02-CORE-GUIDES/mapping/mapping-format-decision-tree.md +480 -480
- package/docs/02-CORE-GUIDES/mapping/mapping-graphql-alias-batching-guide.md +820 -820
- package/docs/02-CORE-GUIDES/mapping/mapping-javascript-objects.md +2369 -2369
- package/docs/02-CORE-GUIDES/mapping/mapping-mapper-comparison-guide.md +682 -682
- package/docs/02-CORE-GUIDES/mapping/modules/02-core-guides-mapping-07-api-reference.md +1327 -1327
- package/docs/02-CORE-GUIDES/mapping/modules/02-core-guides-mapping-08-error-handling.md +1142 -1142
- package/docs/02-CORE-GUIDES/mapping/modules/mapping-04-use-cases.md +891 -891
- package/docs/02-CORE-GUIDES/mapping/modules/mapping-06-helpers-resolvers.md +1126 -1126
- package/docs/02-CORE-GUIDES/mapping/modules/mapping-06-sdk-resolvers.md +199 -199
- package/docs/02-CORE-GUIDES/mapping/modules/mapping-07-api-reference.md +1319 -1319
- package/docs/02-CORE-GUIDES/mapping/readme.md +178 -178
- package/docs/02-CORE-GUIDES/mapping/resolver-registration.md +410 -410
- package/docs/02-CORE-GUIDES/mapping/resolvers/examples/common-patterns.ts +226 -226
- package/docs/02-CORE-GUIDES/mapping/resolvers/examples/custom-resolvers.ts +227 -227
- package/docs/02-CORE-GUIDES/mapping/resolvers/examples/sdk-resolvers-usage.ts +203 -203
- package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-readme.md +274 -274
- package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-api-reference.md +679 -679
- package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-cookbook.md +826 -826
- package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-guide.md +1330 -1330
- package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-helpers-reference.md +1437 -1437
- package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-parameters-reference.md +553 -553
- package/docs/02-CORE-GUIDES/mapping/resolvers/mapping-resolvers-resolver-troubleshooting.md +854 -854
- package/docs/02-CORE-GUIDES/mapping/resolvers/readme.md +75 -75
- package/docs/02-CORE-GUIDES/parsers/examples/02-core-guides-parsers-readme.md +161 -161
- package/docs/02-CORE-GUIDES/parsers/examples/csv-parser-examples.ts +110 -110
- package/docs/02-CORE-GUIDES/parsers/examples/json-parser-examples.ts +33 -33
- package/docs/02-CORE-GUIDES/parsers/examples/parquet-parser-examples.ts +47 -47
- package/docs/02-CORE-GUIDES/parsers/examples/xml-parser-examples.ts +38 -38
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-01-foundations.md +355 -355
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-02-csv-parser.md +772 -772
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-03-json-parser.md +789 -789
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-04-xml-parser.md +857 -857
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-05-parquet-parser.md +603 -603
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-06-integration-patterns.md +702 -702
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-06-streaming.md +121 -121
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-07-api-reference.md +89 -89
- package/docs/02-CORE-GUIDES/parsers/modules/02-core-guides-parsers-07-troubleshooting.md +727 -727
- package/docs/02-CORE-GUIDES/parsers/parsers-quick-reference.md +482 -482
- package/docs/02-CORE-GUIDES/parsers/parsers-readme.md +258 -258
- package/docs/02-CORE-GUIDES/parsers/readme.md +65 -65
- package/docs/02-CORE-GUIDES/readme.md +194 -194
- package/docs/02-CORE-GUIDES/webhook-validation/examples/basic-validation.ts +108 -108
- package/docs/02-CORE-GUIDES/webhook-validation/examples/common-patterns.ts +316 -316
- package/docs/02-CORE-GUIDES/webhook-validation/examples/webhook-validation-readme.md +61 -61
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-01-foundations.md +440 -440
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-02-quick-start.md +525 -525
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-03-versori-integration.md +741 -741
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-04-platform-integration.md +629 -629
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-05-configuration.md +535 -535
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-06-error-handling.md +611 -611
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-06-troubleshooting.md +124 -124
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-07-api-reference.md +511 -511
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-08-rubix-webhooks.md +590 -590
- package/docs/02-CORE-GUIDES/webhook-validation/modules/webhook-validation-09-rubix-event-vs-http-call.md +432 -432
- package/docs/02-CORE-GUIDES/webhook-validation/readme.md +239 -239
- package/docs/02-CORE-GUIDES/webhook-validation/webhook-validation-quick-reference.md +392 -392
- package/docs/03-PATTERN-GUIDES/connector-scenarios/connector-scenarios-quick-reference.md +498 -498
- package/docs/03-PATTERN-GUIDES/connector-scenarios/connector-scenarios-readme.md +313 -313
- package/docs/03-PATTERN-GUIDES/connector-scenarios/examples/common-patterns.ts +612 -612
- package/docs/03-PATTERN-GUIDES/connector-scenarios/examples/connector-scenarios-readme.md +253 -253
- package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-01-foundations.md +452 -452
- package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-02-simple-scenarios.md +681 -681
- package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-03-intermediate-scenarios.md +637 -637
- package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-04-advanced-scenarios.md +650 -650
- package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-05-bidirectional-sync.md +233 -233
- package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-06-production-patterns.md +442 -442
- package/docs/03-PATTERN-GUIDES/connector-scenarios/modules/connector-scenarios-07-reference.md +445 -445
- package/docs/03-PATTERN-GUIDES/connector-scenarios/readme.md +31 -31
- package/docs/03-PATTERN-GUIDES/enterprise-integration-patterns.md +1528 -1528
- package/docs/03-PATTERN-GUIDES/error-handling/comprehensive-error-handling-guide.md +1437 -1437
- package/docs/03-PATTERN-GUIDES/error-handling/error-handling-quick-reference.md +390 -390
- package/docs/03-PATTERN-GUIDES/error-handling/examples/common-patterns.ts +438 -438
- package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-01-foundations.md +362 -362
- package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-02-error-types.md +850 -850
- package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-03-utf8-handling.md +456 -456
- package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-04-error-scenarios.md +658 -658
- package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-05-calling-patterns.md +671 -671
- package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-06-retry-strategies.md +1034 -1034
- package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-07-monitoring.md +653 -653
- package/docs/03-PATTERN-GUIDES/error-handling/modules/error-handling-08-api-reference.md +847 -847
- package/docs/03-PATTERN-GUIDES/error-handling/readme.md +36 -36
- package/docs/03-PATTERN-GUIDES/examples/__tests__/readme.md +40 -40
- package/docs/03-PATTERN-GUIDES/examples/__tests__/resolver-examples.test.js +282 -282
- package/docs/03-PATTERN-GUIDES/examples/test-data/03-pattern-guides-readme.md +110 -110
- package/docs/03-PATTERN-GUIDES/examples/test-data/canonical-inventory.json +123 -123
- package/docs/03-PATTERN-GUIDES/examples/test-data/canonical-order.json +171 -171
- package/docs/03-PATTERN-GUIDES/examples/test-data/readme.md +28 -28
- package/docs/03-PATTERN-GUIDES/extraction/extraction-readme.md +15 -15
- package/docs/03-PATTERN-GUIDES/extraction/readme.md +25 -25
- package/docs/03-PATTERN-GUIDES/file-operations/examples/common-patterns.ts +407 -407
- package/docs/03-PATTERN-GUIDES/file-operations/examples/file-operations-readme.md +142 -142
- package/docs/03-PATTERN-GUIDES/file-operations/file-operations-quick-reference.md +462 -462
- package/docs/03-PATTERN-GUIDES/file-operations/file-operations-readme.md +379 -379
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-01-foundations.md +430 -430
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-02-quick-start.md +484 -484
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-03-s3-operations.md +507 -507
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-04-sftp-operations.md +963 -963
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-05-streaming-performance.md +503 -503
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-06-archive-patterns.md +386 -386
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-06-error-handling.md +117 -117
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-07-api-reference.md +78 -78
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-07-testing-troubleshooting.md +567 -567
- package/docs/03-PATTERN-GUIDES/file-operations/modules/file-operations-08-api-reference.md +1055 -1055
- package/docs/03-PATTERN-GUIDES/file-operations/readme.md +32 -32
- package/docs/03-PATTERN-GUIDES/ingestion/ingestion-readme.md +15 -15
- package/docs/03-PATTERN-GUIDES/ingestion/readme.md +25 -25
- package/docs/03-PATTERN-GUIDES/integration-patterns/examples/batch-processing.ts +130 -130
- package/docs/03-PATTERN-GUIDES/integration-patterns/examples/common-patterns.ts +360 -360
- package/docs/03-PATTERN-GUIDES/integration-patterns/examples/delta-sync.ts +130 -130
- package/docs/03-PATTERN-GUIDES/integration-patterns/examples/integration-patterns-readme.md +100 -100
- package/docs/03-PATTERN-GUIDES/integration-patterns/examples/real-time-webhook.ts +398 -398
- package/docs/03-PATTERN-GUIDES/integration-patterns/integration-patterns-quick-reference.md +962 -962
- package/docs/03-PATTERN-GUIDES/integration-patterns/integration-patterns-readme.md +134 -134
- package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-01-real-time-processing.md +991 -991
- package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-02-batch-processing.md +1547 -1547
- package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-03-delta-sync.md +1108 -1108
- package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-04-webhook-patterns.md +1181 -1181
- package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-05-error-handling.md +1061 -1061
- package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-06-advanced-integration-services.md +1547 -1547
- package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-06-performance.md +109 -109
- package/docs/03-PATTERN-GUIDES/integration-patterns/modules/integration-patterns-07-api-reference.md +34 -34
- package/docs/03-PATTERN-GUIDES/integration-patterns/readme.md +30 -30
- package/docs/03-PATTERN-GUIDES/logging-minimal-mode.md +128 -128
- package/docs/03-PATTERN-GUIDES/multiple-connections/examples/common-patterns.ts +380 -380
- package/docs/03-PATTERN-GUIDES/multiple-connections/examples/multiple-connections-readme.md +139 -139
- package/docs/03-PATTERN-GUIDES/multiple-connections/examples/parallel-root-connections.ts +149 -149
- package/docs/03-PATTERN-GUIDES/multiple-connections/examples/real-world-scenarios.ts +405 -405
- package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-01-foundations.md +378 -378
- package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-02-quick-start.md +566 -566
- package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-03-targeting-connections.md +659 -659
- package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-04-parallel-queries.md +656 -656
- package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-05-best-practices.md +624 -624
- package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-06-api-reference.md +824 -824
- package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-06-versori.md +119 -119
- package/docs/03-PATTERN-GUIDES/multiple-connections/modules/multiple-connections-07-api-reference.md +87 -87
- package/docs/03-PATTERN-GUIDES/multiple-connections/multiple-connections-quick-reference.md +353 -353
- package/docs/03-PATTERN-GUIDES/multiple-connections/multiple-connections-readme.md +270 -270
- package/docs/03-PATTERN-GUIDES/multiple-connections/readme.md +30 -30
- package/docs/03-PATTERN-GUIDES/pagination/pagination-readme.md +14 -14
- package/docs/03-PATTERN-GUIDES/pagination/readme.md +24 -24
- package/docs/03-PATTERN-GUIDES/parquet/examples/common-patterns.ts +180 -180
- package/docs/03-PATTERN-GUIDES/parquet/examples/read-parquet.ts +48 -48
- package/docs/03-PATTERN-GUIDES/parquet/examples/write-parquet.ts +65 -65
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-01-introduction.md +393 -393
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-02-quick-start.md +572 -572
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-03-reading-parquet.md +525 -525
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-04-writing-parquet.md +554 -554
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-05-graphql-extraction.md +405 -405
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-06-performance.md +104 -104
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-06-s3-integration.md +511 -511
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-07-api-reference.md +90 -90
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-07-performance-optimization.md +525 -525
- package/docs/03-PATTERN-GUIDES/parquet/modules/03-pattern-guides-parquet-08-best-practices.md +712 -712
- package/docs/03-PATTERN-GUIDES/parquet/parquet-quick-reference.md +683 -683
- package/docs/03-PATTERN-GUIDES/parquet/parquet-readme.md +248 -248
- package/docs/03-PATTERN-GUIDES/parquet/readme.md +32 -32
- package/docs/03-PATTERN-GUIDES/parsers/parsers-readme.md +12 -12
- package/docs/03-PATTERN-GUIDES/parsers/readme.md +24 -24
- package/docs/03-PATTERN-GUIDES/readme.md +159 -159
- package/docs/03-PATTERN-GUIDES/webhooks/readme.md +24 -24
- package/docs/03-PATTERN-GUIDES/webhooks/webhooks-readme.md +8 -8
- package/docs/04-REFERENCE/architecture/architecture-01-overview.md +427 -427
- package/docs/04-REFERENCE/architecture/architecture-02-client-architecture.md +424 -424
- package/docs/04-REFERENCE/architecture/architecture-03-data-flow.md +690 -690
- package/docs/04-REFERENCE/architecture/architecture-04-service-layer.md +834 -834
- package/docs/04-REFERENCE/architecture/architecture-05-integration-architecture.md +655 -655
- package/docs/04-REFERENCE/architecture/architecture-06-state-management.md +653 -653
- package/docs/04-REFERENCE/architecture/architecture-adding-new-data-sources.md +686 -686
- package/docs/04-REFERENCE/architecture/readme.md +279 -279
- package/docs/04-REFERENCE/platforms/deno/readme.md +117 -117
- package/docs/04-REFERENCE/platforms/nodejs/readme.md +146 -146
- package/docs/04-REFERENCE/platforms/readme.md +135 -135
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-01-introduction.md +398 -398
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-02-quick-start.md +560 -560
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-03-authentication.md +757 -757
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-04-workflows.md +2476 -2476
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-05-connections.md +1167 -1167
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-06-kv-storage.md +990 -990
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-06-state-management.md +121 -121
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-07-api-reference.md +68 -68
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-07-deployment.md +731 -731
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-08-best-practices.md +1111 -1111
- package/docs/04-REFERENCE/platforms/versori/modules/platforms-versori-09-signature-reference.md +766 -766
- package/docs/04-REFERENCE/platforms/versori/platforms-versori-readme.md +299 -299
- package/docs/04-REFERENCE/platforms/versori/platforms-versori-s3-sftp-configuration-guide.md +1425 -1425
- package/docs/04-REFERENCE/platforms/versori/platforms-versori-webhook-api-key-security.md +816 -816
- package/docs/04-REFERENCE/platforms/versori/platforms-versori-webhook-connection-security.md +681 -681
- package/docs/04-REFERENCE/platforms/versori/platforms-versori-workflow-task-types.md +708 -708
- package/docs/04-REFERENCE/platforms/versori/readme.md +108 -108
- package/docs/04-REFERENCE/readme.md +148 -148
- package/docs/04-REFERENCE/resolver-signature/examples/advanced-resolvers.ts +482 -482
- package/docs/04-REFERENCE/resolver-signature/examples/async-resolvers.ts +496 -496
- package/docs/04-REFERENCE/resolver-signature/examples/basic-resolvers.ts +343 -343
- package/docs/04-REFERENCE/resolver-signature/examples/resolver-signature-readme.md +188 -188
- package/docs/04-REFERENCE/resolver-signature/examples/testing-resolvers.ts +463 -463
- package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-01-foundations.md +286 -286
- package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-02-parameter-reference.md +643 -643
- package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-03-basic-examples.md +521 -521
- package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-04-advanced-patterns.md +739 -739
- package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-05-sdk-resolvers.md +531 -531
- package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-06-migration-guide.md +650 -650
- package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-06-testing.md +125 -125
- package/docs/04-REFERENCE/resolver-signature/modules/resolver-signature-07-api-reference.md +794 -794
- package/docs/04-REFERENCE/resolver-signature/readme.md +64 -64
- package/docs/04-REFERENCE/resolver-signature/resolver-signature-quick-reference.md +270 -270
- package/docs/04-REFERENCE/resolver-signature/resolver-signature-readme.md +351 -351
- package/docs/04-REFERENCE/schema/fluent-commerce-schema.json +764 -764
- package/docs/04-REFERENCE/schema/readme.md +141 -141
- package/docs/04-REFERENCE/testing/examples/04-reference-testing-readme.md +158 -158
- package/docs/04-REFERENCE/testing/examples/fluent-testing.ts +62 -62
- package/docs/04-REFERENCE/testing/examples/health-check.ts +155 -155
- package/docs/04-REFERENCE/testing/examples/integration-test.ts +119 -119
- package/docs/04-REFERENCE/testing/examples/performance-test.ts +183 -183
- package/docs/04-REFERENCE/testing/examples/s3-testing.ts +127 -127
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-01-foundations.md +267 -267
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-02-s3-testing.md +599 -599
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-03-fluent-testing.md +589 -589
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-04-integration-testing.md +699 -699
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-05-debugging.md +478 -478
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-06-cicd-integration.md +463 -463
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-06-preflight-validation.md +131 -131
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-07-best-practices.md +499 -499
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-07-coverage-ci.md +165 -165
- package/docs/04-REFERENCE/testing/modules/04-reference-testing-08-api-reference.md +634 -634
- package/docs/04-REFERENCE/testing/readme.md +86 -86
- package/docs/04-REFERENCE/testing/testing-quick-reference.md +667 -667
- package/docs/04-REFERENCE/testing/testing-readme.md +286 -286
- package/docs/04-REFERENCE/troubleshooting/readme.md +144 -144
- package/docs/04-REFERENCE/troubleshooting/troubleshooting-deno-sftp-compatibility.md +392 -392
- package/docs/template-loading-matrix.md +242 -242
- package/package.json +5 -3
- package/docs/02-CORE-GUIDES/api-reference/cli-profile-integration.md +0 -377
|
@@ -1,732 +1,732 @@
|
|
|
1
|
-
# Module 4: Advanced Query Patterns
|
|
2
|
-
|
|
3
|
-
> **Learning Objective:** Master complex pagination scenarios including nested connections, fragments, aliases, and multiple connections.
|
|
4
|
-
>
|
|
5
|
-
> **Level:** Advanced
|
|
6
|
-
|
|
7
|
-
## Table of Contents
|
|
8
|
-
|
|
9
|
-
1. [Nested Connections](#nested-connections)
|
|
10
|
-
2. [Multiple Connections](#multiple-connections)
|
|
11
|
-
3. [Using Fragments](#using-fragments)
|
|
12
|
-
4. [Query Aliases](#query-aliases)
|
|
13
|
-
5. [Inline Fragments](#inline-fragments)
|
|
14
|
-
6. [Custom Variable Names](#custom-variable-names)
|
|
15
|
-
7. [Filtering with Pagination](#filtering-with-pagination)
|
|
16
|
-
8. [Backward Pagination](#backward-pagination)
|
|
17
|
-
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
## Nested Connections
|
|
21
|
-
|
|
22
|
-
Paginate nested collections (e.g., order ā items).
|
|
23
|
-
|
|
24
|
-
### Example: Order Items Pagination
|
|
25
|
-
|
|
26
|
-
```typescript
|
|
27
|
-
const result = await client.graphql({
|
|
28
|
-
query: `
|
|
29
|
-
query GetOrderItems($orderId: ID!, $first: Int!, $after: String) {
|
|
30
|
-
order(id: $orderId) {
|
|
31
|
-
id
|
|
32
|
-
ref
|
|
33
|
-
status
|
|
34
|
-
items(first: $first, after: $after) {
|
|
35
|
-
edges {
|
|
36
|
-
node {
|
|
37
|
-
id
|
|
38
|
-
productRef
|
|
39
|
-
quantity
|
|
40
|
-
price
|
|
41
|
-
}
|
|
42
|
-
cursor
|
|
43
|
-
}
|
|
44
|
-
pageInfo {
|
|
45
|
-
hasNextPage
|
|
46
|
-
}
|
|
47
|
-
}
|
|
48
|
-
}
|
|
49
|
-
}
|
|
50
|
-
`,
|
|
51
|
-
variables: {
|
|
52
|
-
orderId: 'ORDER-123',
|
|
53
|
-
first: 50
|
|
54
|
-
},
|
|
55
|
-
pagination: {
|
|
56
|
-
connectionPath: 'order.items', // Target nested connection!
|
|
57
|
-
maxPages: 20,
|
|
58
|
-
maxRecords: 1000
|
|
59
|
-
}
|
|
60
|
-
});
|
|
61
|
-
|
|
62
|
-
// Access nested items
|
|
63
|
-
const items = result.data.order.items.edges;
|
|
64
|
-
console.log(`Total items: ${result.extensions.autoPagination.totalRecords}`);
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
### Multi-Level Nesting
|
|
68
|
-
|
|
69
|
-
```typescript
|
|
70
|
-
// Query with multiple nesting levels
|
|
71
|
-
const result = await client.graphql({
|
|
72
|
-
query: `
|
|
73
|
-
query GetFulfilmentArticles($fulfilmentId: ID!, $first: Int!, $after: String) {
|
|
74
|
-
fulfilment(id: $fulfilmentId) {
|
|
75
|
-
id
|
|
76
|
-
order {
|
|
77
|
-
id
|
|
78
|
-
ref
|
|
79
|
-
}
|
|
80
|
-
articles(first: $first, after: $after) {
|
|
81
|
-
edges {
|
|
82
|
-
node {
|
|
83
|
-
id
|
|
84
|
-
requestedQuantity
|
|
85
|
-
}
|
|
86
|
-
cursor
|
|
87
|
-
}
|
|
88
|
-
pageInfo {
|
|
89
|
-
hasNextPage
|
|
90
|
-
}
|
|
91
|
-
}
|
|
92
|
-
}
|
|
93
|
-
}
|
|
94
|
-
`,
|
|
95
|
-
variables: { fulfilmentId: 'FUL-456', first: 30 },
|
|
96
|
-
pagination: {
|
|
97
|
-
connectionPath: 'fulfilment.articles',
|
|
98
|
-
maxPages: 15
|
|
99
|
-
}
|
|
100
|
-
});
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
---
|
|
104
|
-
|
|
105
|
-
## Multiple Connections
|
|
106
|
-
|
|
107
|
-
Handle queries with multiple pageable connections.
|
|
108
|
-
|
|
109
|
-
### Pattern 1: Paginate One Connection
|
|
110
|
-
|
|
111
|
-
```typescript
|
|
112
|
-
// Multiple connections - paginate only locations
|
|
113
|
-
const result = await client.graphql({
|
|
114
|
-
query: `
|
|
115
|
-
query GetMultiple($first: Int!, $after: String) {
|
|
116
|
-
locations(first: $first, after: $after) {
|
|
117
|
-
edges {
|
|
118
|
-
node { id ref name }
|
|
119
|
-
cursor
|
|
120
|
-
}
|
|
121
|
-
pageInfo { hasNextPage }
|
|
122
|
-
}
|
|
123
|
-
products(first: 10) { # Not paginated - fixed size
|
|
124
|
-
edges {
|
|
125
|
-
node { id ref }
|
|
126
|
-
}
|
|
127
|
-
}
|
|
128
|
-
}
|
|
129
|
-
`,
|
|
130
|
-
variables: { first: 100 },
|
|
131
|
-
pagination: {
|
|
132
|
-
connectionPath: 'locations', // Paginate locations only
|
|
133
|
-
maxPages: 50
|
|
134
|
-
}
|
|
135
|
-
});
|
|
136
|
-
|
|
137
|
-
// result.data.locations.edges - fully paginated
|
|
138
|
-
// result.data.products.edges - only first 10 items
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
### Pattern 2: Sequential Pagination
|
|
142
|
-
|
|
143
|
-
Paginate multiple connections sequentially (separate queries):
|
|
144
|
-
|
|
145
|
-
```typescript
|
|
146
|
-
// Fetch all locations
|
|
147
|
-
const locationsResult = await client.graphql({
|
|
148
|
-
query: `
|
|
149
|
-
query GetLocations($first: Int!, $after: String) {
|
|
150
|
-
locations(first: $first, after: $after) {
|
|
151
|
-
edges {
|
|
152
|
-
node { id ref }
|
|
153
|
-
cursor
|
|
154
|
-
}
|
|
155
|
-
pageInfo { hasNextPage }
|
|
156
|
-
}
|
|
157
|
-
}
|
|
158
|
-
`,
|
|
159
|
-
variables: { first: 100 },
|
|
160
|
-
pagination: { maxRecords: 5000 }
|
|
161
|
-
});
|
|
162
|
-
|
|
163
|
-
// Then fetch all products
|
|
164
|
-
const productsResult = await client.graphql({
|
|
165
|
-
query: `
|
|
166
|
-
query GetProducts($first: Int!, $after: String) {
|
|
167
|
-
products(first: $first, after: $after) {
|
|
168
|
-
edges {
|
|
169
|
-
node { id ref }
|
|
170
|
-
cursor
|
|
171
|
-
}
|
|
172
|
-
pageInfo { hasNextPage }
|
|
173
|
-
}
|
|
174
|
-
}
|
|
175
|
-
`,
|
|
176
|
-
variables: { first: 100 },
|
|
177
|
-
pagination: { maxRecords: 10000 }
|
|
178
|
-
});
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
---
|
|
182
|
-
|
|
183
|
-
## Using Fragments
|
|
184
|
-
|
|
185
|
-
Auto-pagination works seamlessly with GraphQL fragments.
|
|
186
|
-
|
|
187
|
-
### Named Fragments
|
|
188
|
-
|
|
189
|
-
```typescript
|
|
190
|
-
const result = await client.graphql({
|
|
191
|
-
query: `
|
|
192
|
-
fragment LocationFields on Location {
|
|
193
|
-
id
|
|
194
|
-
ref
|
|
195
|
-
name
|
|
196
|
-
type
|
|
197
|
-
status
|
|
198
|
-
defaultCarrier
|
|
199
|
-
}
|
|
200
|
-
|
|
201
|
-
query GetLocations($first: Int!, $after: String) {
|
|
202
|
-
locations(first: $first, after: $after) {
|
|
203
|
-
edges {
|
|
204
|
-
node {
|
|
205
|
-
...LocationFields
|
|
206
|
-
}
|
|
207
|
-
cursor
|
|
208
|
-
}
|
|
209
|
-
pageInfo {
|
|
210
|
-
hasNextPage
|
|
211
|
-
}
|
|
212
|
-
}
|
|
213
|
-
}
|
|
214
|
-
`,
|
|
215
|
-
variables: { first: 100 },
|
|
216
|
-
pagination: { maxPages: 50 }
|
|
217
|
-
});
|
|
218
|
-
```
|
|
219
|
-
|
|
220
|
-
### Nested Fragments
|
|
221
|
-
|
|
222
|
-
```typescript
|
|
223
|
-
const result = await client.graphql({
|
|
224
|
-
query: `
|
|
225
|
-
fragment ProductBasic on Product {
|
|
226
|
-
id
|
|
227
|
-
ref
|
|
228
|
-
type
|
|
229
|
-
gtin
|
|
230
|
-
}
|
|
231
|
-
|
|
232
|
-
fragment ProductDetails on Product {
|
|
233
|
-
...ProductBasic
|
|
234
|
-
status
|
|
235
|
-
createdOn
|
|
236
|
-
updatedOn
|
|
237
|
-
}
|
|
238
|
-
|
|
239
|
-
query GetProducts($first: Int!, $after: String) {
|
|
240
|
-
products(first: $first, after: $after) {
|
|
241
|
-
edges {
|
|
242
|
-
node {
|
|
243
|
-
...ProductDetails
|
|
244
|
-
}
|
|
245
|
-
cursor
|
|
246
|
-
}
|
|
247
|
-
pageInfo {
|
|
248
|
-
hasNextPage
|
|
249
|
-
}
|
|
250
|
-
}
|
|
251
|
-
}
|
|
252
|
-
`,
|
|
253
|
-
variables: { first: 75 },
|
|
254
|
-
pagination: { maxRecords: 5000 }
|
|
255
|
-
});
|
|
256
|
-
```
|
|
257
|
-
|
|
258
|
-
---
|
|
259
|
-
|
|
260
|
-
## Query Aliases
|
|
261
|
-
|
|
262
|
-
Use aliases to rename fields in responses.
|
|
263
|
-
|
|
264
|
-
### Basic Aliases
|
|
265
|
-
|
|
266
|
-
```typescript
|
|
267
|
-
const result = await client.graphql({
|
|
268
|
-
query: `
|
|
269
|
-
query GetLocations($first: Int!, $after: String) {
|
|
270
|
-
allLocations: locations(first: $first, after: $after) {
|
|
271
|
-
edges {
|
|
272
|
-
node {
|
|
273
|
-
locationId: id
|
|
274
|
-
locationRef: ref
|
|
275
|
-
locationName: name
|
|
276
|
-
}
|
|
277
|
-
cursor
|
|
278
|
-
}
|
|
279
|
-
pageInfo {
|
|
280
|
-
hasNextPage
|
|
281
|
-
}
|
|
282
|
-
}
|
|
283
|
-
}
|
|
284
|
-
`,
|
|
285
|
-
variables: { first: 100 },
|
|
286
|
-
pagination: {
|
|
287
|
-
connectionPath: 'allLocations', // Use the alias!
|
|
288
|
-
maxPages: 50
|
|
289
|
-
}
|
|
290
|
-
});
|
|
291
|
-
|
|
292
|
-
// Access via alias
|
|
293
|
-
const locations = result.data.allLocations.edges;
|
|
294
|
-
console.log(locations[0].node.locationName); // Aliased field
|
|
295
|
-
```
|
|
296
|
-
|
|
297
|
-
### Multiple Queries with Aliases
|
|
298
|
-
|
|
299
|
-
```typescript
|
|
300
|
-
const result = await client.graphql({
|
|
301
|
-
query: `
|
|
302
|
-
query GetData($first: Int!, $after: String) {
|
|
303
|
-
activeLocations: locations(first: $first, after: $after, status: "ACTIVE") {
|
|
304
|
-
edges {
|
|
305
|
-
node { id ref status }
|
|
306
|
-
cursor
|
|
307
|
-
}
|
|
308
|
-
pageInfo { hasNextPage }
|
|
309
|
-
}
|
|
310
|
-
inactiveLocations: locations(first: $first, status: "INACTIVE") {
|
|
311
|
-
edges {
|
|
312
|
-
node { id ref status }
|
|
313
|
-
}
|
|
314
|
-
}
|
|
315
|
-
}
|
|
316
|
-
`,
|
|
317
|
-
variables: { first: 100 },
|
|
318
|
-
pagination: {
|
|
319
|
-
connectionPath: 'activeLocations', // Paginate only active
|
|
320
|
-
maxPages: 50
|
|
321
|
-
}
|
|
322
|
-
});
|
|
323
|
-
```
|
|
324
|
-
|
|
325
|
-
---
|
|
326
|
-
|
|
327
|
-
## Inline Fragments
|
|
328
|
-
|
|
329
|
-
Use inline fragments for interface/union types.
|
|
330
|
-
|
|
331
|
-
```typescript
|
|
332
|
-
const result = await client.graphql({
|
|
333
|
-
query: `
|
|
334
|
-
query GetProducts($first: Int!, $after: String) {
|
|
335
|
-
products(first: $first, after: $after) {
|
|
336
|
-
edges {
|
|
337
|
-
node {
|
|
338
|
-
id
|
|
339
|
-
ref
|
|
340
|
-
... on StandardProduct {
|
|
341
|
-
gtin
|
|
342
|
-
attributes {
|
|
343
|
-
name
|
|
344
|
-
value
|
|
345
|
-
}
|
|
346
|
-
}
|
|
347
|
-
... on VariantProduct {
|
|
348
|
-
gtin
|
|
349
|
-
options {
|
|
350
|
-
name
|
|
351
|
-
value
|
|
352
|
-
}
|
|
353
|
-
}
|
|
354
|
-
}
|
|
355
|
-
cursor
|
|
356
|
-
}
|
|
357
|
-
pageInfo {
|
|
358
|
-
hasNextPage
|
|
359
|
-
}
|
|
360
|
-
}
|
|
361
|
-
}
|
|
362
|
-
`,
|
|
363
|
-
variables: { first: 75 },
|
|
364
|
-
pagination: { maxPages: 50 }
|
|
365
|
-
});
|
|
366
|
-
```
|
|
367
|
-
|
|
368
|
-
---
|
|
369
|
-
|
|
370
|
-
## Custom Variable Names
|
|
371
|
-
|
|
372
|
-
SDK detects pagination variables even with custom names.
|
|
373
|
-
|
|
374
|
-
### Pattern Detection
|
|
375
|
-
|
|
376
|
-
SDK recognizes these patterns:
|
|
377
|
-
- `$first` or `$*First` (e.g., `$itemsFirst`)
|
|
378
|
-
- `$after` or `$*After` (e.g., `$itemsAfter`)
|
|
379
|
-
- `$last` or `$*Last` (e.g., `$itemsLast`)
|
|
380
|
-
- `$before` or `$*Before` (e.g., `$itemsBefore`)
|
|
381
|
-
|
|
382
|
-
### Example with Custom Names
|
|
383
|
-
|
|
384
|
-
```typescript
|
|
385
|
-
const result = await client.graphql({
|
|
386
|
-
query: `
|
|
387
|
-
query GetItems($itemsFirst: Int!, $itemsAfter: String) {
|
|
388
|
-
items(first: $itemsFirst, after: $itemsAfter) {
|
|
389
|
-
edges {
|
|
390
|
-
node { id ref }
|
|
391
|
-
cursor
|
|
392
|
-
}
|
|
393
|
-
pageInfo { hasNextPage }
|
|
394
|
-
}
|
|
395
|
-
}
|
|
396
|
-
`,
|
|
397
|
-
variables: { itemsFirst: 100 }, // Custom variable name
|
|
398
|
-
pagination: { maxPages: 50 }
|
|
399
|
-
// SDK automatically detects $itemsFirst and $itemsAfter!
|
|
400
|
-
});
|
|
401
|
-
```
|
|
402
|
-
|
|
403
|
-
---
|
|
404
|
-
|
|
405
|
-
## Filtering with Pagination
|
|
406
|
-
|
|
407
|
-
Combine filters with pagination for targeted queries.
|
|
408
|
-
|
|
409
|
-
### Date Range Filtering
|
|
410
|
-
|
|
411
|
-
```typescript
|
|
412
|
-
const result = await client.graphql({
|
|
413
|
-
query: `
|
|
414
|
-
query GetRecentOrders($first: Int!, $after: String, $from: DateTime!, $to: DateTime!) {
|
|
415
|
-
orders(
|
|
416
|
-
first: $first
|
|
417
|
-
after: $after
|
|
418
|
-
createdOn: { from: $from, to: $to }
|
|
419
|
-
) {
|
|
420
|
-
edges {
|
|
421
|
-
node {
|
|
422
|
-
id
|
|
423
|
-
ref
|
|
424
|
-
status
|
|
425
|
-
createdOn
|
|
426
|
-
}
|
|
427
|
-
cursor
|
|
428
|
-
}
|
|
429
|
-
pageInfo { hasNextPage }
|
|
430
|
-
}
|
|
431
|
-
}
|
|
432
|
-
`,
|
|
433
|
-
variables: {
|
|
434
|
-
first: 100,
|
|
435
|
-
from: '2024-01-01T00:00:00Z',
|
|
436
|
-
to: '2024-12-31T23:59:59Z'
|
|
437
|
-
},
|
|
438
|
-
pagination: { maxRecords: 10000 }
|
|
439
|
-
});
|
|
440
|
-
```
|
|
441
|
-
|
|
442
|
-
### Status Filtering
|
|
443
|
-
|
|
444
|
-
```typescript
|
|
445
|
-
const result = await client.graphql({
|
|
446
|
-
query: `
|
|
447
|
-
query GetActivePositions($first: Int!, $after: String, $status: [String!]) {
|
|
448
|
-
virtualPositions(
|
|
449
|
-
first: $first
|
|
450
|
-
after: $after
|
|
451
|
-
status: $status
|
|
452
|
-
) {
|
|
453
|
-
edges {
|
|
454
|
-
node {
|
|
455
|
-
id
|
|
456
|
-
ref
|
|
457
|
-
productRef
|
|
458
|
-
quantity
|
|
459
|
-
status
|
|
460
|
-
}
|
|
461
|
-
cursor
|
|
462
|
-
}
|
|
463
|
-
pageInfo { hasNextPage }
|
|
464
|
-
}
|
|
465
|
-
}
|
|
466
|
-
`,
|
|
467
|
-
variables: {
|
|
468
|
-
first: 150,
|
|
469
|
-
status: ['ACTIVE', 'AVAILABLE']
|
|
470
|
-
},
|
|
471
|
-
pagination: { maxPages: 100 }
|
|
472
|
-
});
|
|
473
|
-
```
|
|
474
|
-
|
|
475
|
-
### Reference List Filtering
|
|
476
|
-
|
|
477
|
-
```typescript
|
|
478
|
-
const result = await client.graphql({
|
|
479
|
-
query: `
|
|
480
|
-
query GetSpecificProducts($first: Int!, $after: String, $refs: [String!]!) {
|
|
481
|
-
products(
|
|
482
|
-
first: $first
|
|
483
|
-
after: $after
|
|
484
|
-
ref: $refs
|
|
485
|
-
) {
|
|
486
|
-
edges {
|
|
487
|
-
node {
|
|
488
|
-
id
|
|
489
|
-
ref
|
|
490
|
-
type
|
|
491
|
-
}
|
|
492
|
-
cursor
|
|
493
|
-
}
|
|
494
|
-
pageInfo { hasNextPage }
|
|
495
|
-
}
|
|
496
|
-
}
|
|
497
|
-
`,
|
|
498
|
-
variables: {
|
|
499
|
-
first: 100,
|
|
500
|
-
refs: ['PROD-001', 'PROD-002', 'PROD-003']
|
|
501
|
-
},
|
|
502
|
-
pagination: { maxPages: 10 }
|
|
503
|
-
});
|
|
504
|
-
```
|
|
505
|
-
|
|
506
|
-
---
|
|
507
|
-
|
|
508
|
-
## Backward Pagination
|
|
509
|
-
|
|
510
|
-
Paginate in reverse order using `last` and `before`.
|
|
511
|
-
|
|
512
|
-
### Basic Backward Pagination
|
|
513
|
-
|
|
514
|
-
```typescript
|
|
515
|
-
const result = await client.graphql({
|
|
516
|
-
query: `
|
|
517
|
-
query GetLatestItems($last: Int!, $before: String) {
|
|
518
|
-
items(last: $last, before: $before) {
|
|
519
|
-
edges {
|
|
520
|
-
node { id ref createdOn }
|
|
521
|
-
cursor
|
|
522
|
-
}
|
|
523
|
-
pageInfo {
|
|
524
|
-
hasPreviousPage
|
|
525
|
-
}
|
|
526
|
-
}
|
|
527
|
-
}
|
|
528
|
-
`,
|
|
529
|
-
variables: { last: 100 },
|
|
530
|
-
pagination: {
|
|
531
|
-
direction: 'backward', // Required!
|
|
532
|
-
maxPages: 50
|
|
533
|
-
}
|
|
534
|
-
});
|
|
535
|
-
|
|
536
|
-
// Items are in reverse chronological order
|
|
537
|
-
```
|
|
538
|
-
|
|
539
|
-
### Reverse then Forward
|
|
540
|
-
|
|
541
|
-
Get last page first, then paginate backward:
|
|
542
|
-
|
|
543
|
-
```typescript
|
|
544
|
-
// Step 1: Get cursor of last item
|
|
545
|
-
const lastPageResult = await client.graphql({
|
|
546
|
-
query: `
|
|
547
|
-
query GetLastPage($last: Int!) {
|
|
548
|
-
items(last: $last) {
|
|
549
|
-
edges {
|
|
550
|
-
cursor
|
|
551
|
-
node { id ref }
|
|
552
|
-
}
|
|
553
|
-
pageInfo { hasPreviousPage }
|
|
554
|
-
}
|
|
555
|
-
}
|
|
556
|
-
`,
|
|
557
|
-
variables: { last: 1 },
|
|
558
|
-
pagination: { enabled: false } // Disable auto-pagination
|
|
559
|
-
});
|
|
560
|
-
|
|
561
|
-
const lastCursor = lastPageResult.data.items.edges[0]?.cursor;
|
|
562
|
-
|
|
563
|
-
// Step 2: Paginate backward from last cursor
|
|
564
|
-
const backwardResult = await client.graphql({
|
|
565
|
-
query: `
|
|
566
|
-
query GetItemsBackward($last: Int!, $before: String) {
|
|
567
|
-
items(last: $last, before: $before) {
|
|
568
|
-
edges {
|
|
569
|
-
node { id ref }
|
|
570
|
-
cursor
|
|
571
|
-
}
|
|
572
|
-
pageInfo { hasPreviousPage }
|
|
573
|
-
}
|
|
574
|
-
}
|
|
575
|
-
`,
|
|
576
|
-
variables: { last: 100, before: lastCursor },
|
|
577
|
-
pagination: {
|
|
578
|
-
direction: 'backward',
|
|
579
|
-
maxPages: 50
|
|
580
|
-
}
|
|
581
|
-
});
|
|
582
|
-
```
|
|
583
|
-
|
|
584
|
-
---
|
|
585
|
-
|
|
586
|
-
## Complete Real-World Examples
|
|
587
|
-
|
|
588
|
-
### Example 1: Multi-Warehouse Inventory Export
|
|
589
|
-
|
|
590
|
-
```typescript
|
|
591
|
-
async function exportWarehouseInventory(warehouseRefs: string[]) {
|
|
592
|
-
const results = [];
|
|
593
|
-
|
|
594
|
-
for (const warehouseRef of warehouseRefs) {
|
|
595
|
-
console.log(`\nš¦ Exporting inventory for ${warehouseRef}...`);
|
|
596
|
-
|
|
597
|
-
const result = await client.graphql({
|
|
598
|
-
query: `
|
|
599
|
-
query GetWarehouseInventory($first: Int!, $after: String, $groupRef: String!) {
|
|
600
|
-
virtualPositions(
|
|
601
|
-
first: $first
|
|
602
|
-
after: $after
|
|
603
|
-
groupRef: $groupRef
|
|
604
|
-
status: ["ACTIVE", "AVAILABLE"]
|
|
605
|
-
) {
|
|
606
|
-
edges {
|
|
607
|
-
node {
|
|
608
|
-
id
|
|
609
|
-
productRef
|
|
610
|
-
quantity
|
|
611
|
-
groupRef
|
|
612
|
-
status
|
|
613
|
-
}
|
|
614
|
-
cursor
|
|
615
|
-
}
|
|
616
|
-
pageInfo { hasNextPage }
|
|
617
|
-
}
|
|
618
|
-
}
|
|
619
|
-
`,
|
|
620
|
-
variables: {
|
|
621
|
-
first: 150,
|
|
622
|
-
groupRef: warehouseRef
|
|
623
|
-
},
|
|
624
|
-
pagination: {
|
|
625
|
-
maxRecords: 10000,
|
|
626
|
-
onProgress: (page, records) => {
|
|
627
|
-
process.stdout.write(`\r Page ${page}: ${records} positions...`);
|
|
628
|
-
}
|
|
629
|
-
}
|
|
630
|
-
});
|
|
631
|
-
|
|
632
|
-
results.push({
|
|
633
|
-
warehouse: warehouseRef,
|
|
634
|
-
positions: result.data.virtualPositions.edges,
|
|
635
|
-
stats: result.extensions.autoPagination
|
|
636
|
-
});
|
|
637
|
-
|
|
638
|
-
console.log(`\n ā
${result.extensions.autoPagination.totalRecords} positions exported`);
|
|
639
|
-
}
|
|
640
|
-
|
|
641
|
-
return results;
|
|
642
|
-
}
|
|
643
|
-
|
|
644
|
-
// Usage
|
|
645
|
-
const warehouseData = await exportWarehouseInventory(['WH-EAST', 'WH-WEST', 'WH-CENTRAL']);
|
|
646
|
-
```
|
|
647
|
-
|
|
648
|
-
### Example 2: Recent Orders with Items
|
|
649
|
-
|
|
650
|
-
```typescript
|
|
651
|
-
async function getRecentOrdersWithItems(daysSince: number) {
|
|
652
|
-
const fromDate = new Date();
|
|
653
|
-
fromDate.setDate(fromDate.getDate() - daysSince);
|
|
654
|
-
|
|
655
|
-
const result = await client.graphql({
|
|
656
|
-
query: `
|
|
657
|
-
query GetRecentOrders($first: Int!, $after: String, $from: DateTime!) {
|
|
658
|
-
orders(
|
|
659
|
-
first: $first
|
|
660
|
-
after: $after
|
|
661
|
-
createdOn: { from: $from }
|
|
662
|
-
status: ["BOOKED", "ALLOCATED"]
|
|
663
|
-
) {
|
|
664
|
-
edges {
|
|
665
|
-
node {
|
|
666
|
-
id
|
|
667
|
-
ref
|
|
668
|
-
status
|
|
669
|
-
createdOn
|
|
670
|
-
totalPrice
|
|
671
|
-
items {
|
|
672
|
-
edges {
|
|
673
|
-
node {
|
|
674
|
-
id
|
|
675
|
-
productRef
|
|
676
|
-
quantity
|
|
677
|
-
price
|
|
678
|
-
}
|
|
679
|
-
}
|
|
680
|
-
}
|
|
681
|
-
}
|
|
682
|
-
cursor
|
|
683
|
-
}
|
|
684
|
-
pageInfo { hasNextPage }
|
|
685
|
-
}
|
|
686
|
-
}
|
|
687
|
-
`,
|
|
688
|
-
variables: {
|
|
689
|
-
first: 25, // Small page size for complex query
|
|
690
|
-
from: fromDate.toISOString()
|
|
691
|
-
},
|
|
692
|
-
pagination: {
|
|
693
|
-
maxPages: 40,
|
|
694
|
-
maxRecords: 1000,
|
|
695
|
-
delayMs: 100, // Rate limiting for complex query
|
|
696
|
-
onProgress: (page, records) => {
|
|
697
|
-
console.log(`š Fetched ${records} orders across ${page} pages`);
|
|
698
|
-
}
|
|
699
|
-
}
|
|
700
|
-
});
|
|
701
|
-
|
|
702
|
-
return result.data.orders.edges;
|
|
703
|
-
}
|
|
704
|
-
|
|
705
|
-
// Usage
|
|
706
|
-
const orders = await getRecentOrdersWithItems(7); // Last 7 days
|
|
707
|
-
console.log(`Total orders: ${orders.length}`);
|
|
708
|
-
```
|
|
709
|
-
|
|
710
|
-
---
|
|
711
|
-
|
|
712
|
-
## Key Takeaways
|
|
713
|
-
|
|
714
|
-
ā
**Nested connections**: Use `connectionPath` with dot notation
|
|
715
|
-
ā
**Multiple connections**: Specify which to paginate with `connectionPath`
|
|
716
|
-
ā
**Fragments**: Work seamlessly with auto-pagination
|
|
717
|
-
ā
**Aliases**: Update `connectionPath` to match alias
|
|
718
|
-
ā
**Custom variables**: SDK auto-detects `$*First`, `$*After` patterns
|
|
719
|
-
ā
**Filtering**: Combine filters with pagination variables
|
|
720
|
-
ā
**Backward pagination**: Use `direction: 'backward'` with `$last`/`$before`
|
|
721
|
-
|
|
722
|
-
---
|
|
723
|
-
|
|
724
|
-
## Next Steps
|
|
725
|
-
|
|
726
|
-
Learn how to integrate pagination with other SDK services:
|
|
727
|
-
|
|
728
|
-
**Continue to:** [Module 5: SDK Integration ā](./auto-pagination-05-sdk-integration.md)
|
|
729
|
-
|
|
730
|
-
---
|
|
731
|
-
|
|
732
|
-
[ā Back to Index](../../advanced-services/advanced-services-readme.md) | [ā Previous: Configuration](./auto-pagination-03-configuration.md) | [Next: SDK Integration ā](./auto-pagination-05-sdk-integration.md)
|
|
1
|
+
# Module 4: Advanced Query Patterns
|
|
2
|
+
|
|
3
|
+
> **Learning Objective:** Master complex pagination scenarios including nested connections, fragments, aliases, and multiple connections.
|
|
4
|
+
>
|
|
5
|
+
> **Level:** Advanced
|
|
6
|
+
|
|
7
|
+
## Table of Contents
|
|
8
|
+
|
|
9
|
+
1. [Nested Connections](#nested-connections)
|
|
10
|
+
2. [Multiple Connections](#multiple-connections)
|
|
11
|
+
3. [Using Fragments](#using-fragments)
|
|
12
|
+
4. [Query Aliases](#query-aliases)
|
|
13
|
+
5. [Inline Fragments](#inline-fragments)
|
|
14
|
+
6. [Custom Variable Names](#custom-variable-names)
|
|
15
|
+
7. [Filtering with Pagination](#filtering-with-pagination)
|
|
16
|
+
8. [Backward Pagination](#backward-pagination)
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Nested Connections
|
|
21
|
+
|
|
22
|
+
Paginate nested collections (e.g., order ā items).
|
|
23
|
+
|
|
24
|
+
### Example: Order Items Pagination
|
|
25
|
+
|
|
26
|
+
```typescript
|
|
27
|
+
const result = await client.graphql({
|
|
28
|
+
query: `
|
|
29
|
+
query GetOrderItems($orderId: ID!, $first: Int!, $after: String) {
|
|
30
|
+
order(id: $orderId) {
|
|
31
|
+
id
|
|
32
|
+
ref
|
|
33
|
+
status
|
|
34
|
+
items(first: $first, after: $after) {
|
|
35
|
+
edges {
|
|
36
|
+
node {
|
|
37
|
+
id
|
|
38
|
+
productRef
|
|
39
|
+
quantity
|
|
40
|
+
price
|
|
41
|
+
}
|
|
42
|
+
cursor
|
|
43
|
+
}
|
|
44
|
+
pageInfo {
|
|
45
|
+
hasNextPage
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
`,
|
|
51
|
+
variables: {
|
|
52
|
+
orderId: 'ORDER-123',
|
|
53
|
+
first: 50
|
|
54
|
+
},
|
|
55
|
+
pagination: {
|
|
56
|
+
connectionPath: 'order.items', // Target nested connection!
|
|
57
|
+
maxPages: 20,
|
|
58
|
+
maxRecords: 1000
|
|
59
|
+
}
|
|
60
|
+
});
|
|
61
|
+
|
|
62
|
+
// Access nested items
|
|
63
|
+
const items = result.data.order.items.edges;
|
|
64
|
+
console.log(`Total items: ${result.extensions.autoPagination.totalRecords}`);
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Multi-Level Nesting
|
|
68
|
+
|
|
69
|
+
```typescript
|
|
70
|
+
// Query with multiple nesting levels
|
|
71
|
+
const result = await client.graphql({
|
|
72
|
+
query: `
|
|
73
|
+
query GetFulfilmentArticles($fulfilmentId: ID!, $first: Int!, $after: String) {
|
|
74
|
+
fulfilment(id: $fulfilmentId) {
|
|
75
|
+
id
|
|
76
|
+
order {
|
|
77
|
+
id
|
|
78
|
+
ref
|
|
79
|
+
}
|
|
80
|
+
articles(first: $first, after: $after) {
|
|
81
|
+
edges {
|
|
82
|
+
node {
|
|
83
|
+
id
|
|
84
|
+
requestedQuantity
|
|
85
|
+
}
|
|
86
|
+
cursor
|
|
87
|
+
}
|
|
88
|
+
pageInfo {
|
|
89
|
+
hasNextPage
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
`,
|
|
95
|
+
variables: { fulfilmentId: 'FUL-456', first: 30 },
|
|
96
|
+
pagination: {
|
|
97
|
+
connectionPath: 'fulfilment.articles',
|
|
98
|
+
maxPages: 15
|
|
99
|
+
}
|
|
100
|
+
});
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## Multiple Connections
|
|
106
|
+
|
|
107
|
+
Handle queries with multiple pageable connections.
|
|
108
|
+
|
|
109
|
+
### Pattern 1: Paginate One Connection
|
|
110
|
+
|
|
111
|
+
```typescript
|
|
112
|
+
// Multiple connections - paginate only locations
|
|
113
|
+
const result = await client.graphql({
|
|
114
|
+
query: `
|
|
115
|
+
query GetMultiple($first: Int!, $after: String) {
|
|
116
|
+
locations(first: $first, after: $after) {
|
|
117
|
+
edges {
|
|
118
|
+
node { id ref name }
|
|
119
|
+
cursor
|
|
120
|
+
}
|
|
121
|
+
pageInfo { hasNextPage }
|
|
122
|
+
}
|
|
123
|
+
products(first: 10) { # Not paginated - fixed size
|
|
124
|
+
edges {
|
|
125
|
+
node { id ref }
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
`,
|
|
130
|
+
variables: { first: 100 },
|
|
131
|
+
pagination: {
|
|
132
|
+
connectionPath: 'locations', // Paginate locations only
|
|
133
|
+
maxPages: 50
|
|
134
|
+
}
|
|
135
|
+
});
|
|
136
|
+
|
|
137
|
+
// result.data.locations.edges - fully paginated
|
|
138
|
+
// result.data.products.edges - only first 10 items
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### Pattern 2: Sequential Pagination
|
|
142
|
+
|
|
143
|
+
Paginate multiple connections sequentially (separate queries):
|
|
144
|
+
|
|
145
|
+
```typescript
|
|
146
|
+
// Fetch all locations
|
|
147
|
+
const locationsResult = await client.graphql({
|
|
148
|
+
query: `
|
|
149
|
+
query GetLocations($first: Int!, $after: String) {
|
|
150
|
+
locations(first: $first, after: $after) {
|
|
151
|
+
edges {
|
|
152
|
+
node { id ref }
|
|
153
|
+
cursor
|
|
154
|
+
}
|
|
155
|
+
pageInfo { hasNextPage }
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
`,
|
|
159
|
+
variables: { first: 100 },
|
|
160
|
+
pagination: { maxRecords: 5000 }
|
|
161
|
+
});
|
|
162
|
+
|
|
163
|
+
// Then fetch all products
|
|
164
|
+
const productsResult = await client.graphql({
|
|
165
|
+
query: `
|
|
166
|
+
query GetProducts($first: Int!, $after: String) {
|
|
167
|
+
products(first: $first, after: $after) {
|
|
168
|
+
edges {
|
|
169
|
+
node { id ref }
|
|
170
|
+
cursor
|
|
171
|
+
}
|
|
172
|
+
pageInfo { hasNextPage }
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
`,
|
|
176
|
+
variables: { first: 100 },
|
|
177
|
+
pagination: { maxRecords: 10000 }
|
|
178
|
+
});
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
---
|
|
182
|
+
|
|
183
|
+
## Using Fragments
|
|
184
|
+
|
|
185
|
+
Auto-pagination works seamlessly with GraphQL fragments.
|
|
186
|
+
|
|
187
|
+
### Named Fragments
|
|
188
|
+
|
|
189
|
+
```typescript
|
|
190
|
+
const result = await client.graphql({
|
|
191
|
+
query: `
|
|
192
|
+
fragment LocationFields on Location {
|
|
193
|
+
id
|
|
194
|
+
ref
|
|
195
|
+
name
|
|
196
|
+
type
|
|
197
|
+
status
|
|
198
|
+
defaultCarrier
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
query GetLocations($first: Int!, $after: String) {
|
|
202
|
+
locations(first: $first, after: $after) {
|
|
203
|
+
edges {
|
|
204
|
+
node {
|
|
205
|
+
...LocationFields
|
|
206
|
+
}
|
|
207
|
+
cursor
|
|
208
|
+
}
|
|
209
|
+
pageInfo {
|
|
210
|
+
hasNextPage
|
|
211
|
+
}
|
|
212
|
+
}
|
|
213
|
+
}
|
|
214
|
+
`,
|
|
215
|
+
variables: { first: 100 },
|
|
216
|
+
pagination: { maxPages: 50 }
|
|
217
|
+
});
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
### Nested Fragments
|
|
221
|
+
|
|
222
|
+
```typescript
|
|
223
|
+
const result = await client.graphql({
|
|
224
|
+
query: `
|
|
225
|
+
fragment ProductBasic on Product {
|
|
226
|
+
id
|
|
227
|
+
ref
|
|
228
|
+
type
|
|
229
|
+
gtin
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
fragment ProductDetails on Product {
|
|
233
|
+
...ProductBasic
|
|
234
|
+
status
|
|
235
|
+
createdOn
|
|
236
|
+
updatedOn
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
query GetProducts($first: Int!, $after: String) {
|
|
240
|
+
products(first: $first, after: $after) {
|
|
241
|
+
edges {
|
|
242
|
+
node {
|
|
243
|
+
...ProductDetails
|
|
244
|
+
}
|
|
245
|
+
cursor
|
|
246
|
+
}
|
|
247
|
+
pageInfo {
|
|
248
|
+
hasNextPage
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
`,
|
|
253
|
+
variables: { first: 75 },
|
|
254
|
+
pagination: { maxRecords: 5000 }
|
|
255
|
+
});
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
---
|
|
259
|
+
|
|
260
|
+
## Query Aliases
|
|
261
|
+
|
|
262
|
+
Use aliases to rename fields in responses.
|
|
263
|
+
|
|
264
|
+
### Basic Aliases
|
|
265
|
+
|
|
266
|
+
```typescript
|
|
267
|
+
const result = await client.graphql({
|
|
268
|
+
query: `
|
|
269
|
+
query GetLocations($first: Int!, $after: String) {
|
|
270
|
+
allLocations: locations(first: $first, after: $after) {
|
|
271
|
+
edges {
|
|
272
|
+
node {
|
|
273
|
+
locationId: id
|
|
274
|
+
locationRef: ref
|
|
275
|
+
locationName: name
|
|
276
|
+
}
|
|
277
|
+
cursor
|
|
278
|
+
}
|
|
279
|
+
pageInfo {
|
|
280
|
+
hasNextPage
|
|
281
|
+
}
|
|
282
|
+
}
|
|
283
|
+
}
|
|
284
|
+
`,
|
|
285
|
+
variables: { first: 100 },
|
|
286
|
+
pagination: {
|
|
287
|
+
connectionPath: 'allLocations', // Use the alias!
|
|
288
|
+
maxPages: 50
|
|
289
|
+
}
|
|
290
|
+
});
|
|
291
|
+
|
|
292
|
+
// Access via alias
|
|
293
|
+
const locations = result.data.allLocations.edges;
|
|
294
|
+
console.log(locations[0].node.locationName); // Aliased field
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
### Multiple Queries with Aliases
|
|
298
|
+
|
|
299
|
+
```typescript
|
|
300
|
+
const result = await client.graphql({
|
|
301
|
+
query: `
|
|
302
|
+
query GetData($first: Int!, $after: String) {
|
|
303
|
+
activeLocations: locations(first: $first, after: $after, status: "ACTIVE") {
|
|
304
|
+
edges {
|
|
305
|
+
node { id ref status }
|
|
306
|
+
cursor
|
|
307
|
+
}
|
|
308
|
+
pageInfo { hasNextPage }
|
|
309
|
+
}
|
|
310
|
+
inactiveLocations: locations(first: $first, status: "INACTIVE") {
|
|
311
|
+
edges {
|
|
312
|
+
node { id ref status }
|
|
313
|
+
}
|
|
314
|
+
}
|
|
315
|
+
}
|
|
316
|
+
`,
|
|
317
|
+
variables: { first: 100 },
|
|
318
|
+
pagination: {
|
|
319
|
+
connectionPath: 'activeLocations', // Paginate only active
|
|
320
|
+
maxPages: 50
|
|
321
|
+
}
|
|
322
|
+
});
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
---
|
|
326
|
+
|
|
327
|
+
## Inline Fragments
|
|
328
|
+
|
|
329
|
+
Use inline fragments for interface/union types.
|
|
330
|
+
|
|
331
|
+
```typescript
|
|
332
|
+
const result = await client.graphql({
|
|
333
|
+
query: `
|
|
334
|
+
query GetProducts($first: Int!, $after: String) {
|
|
335
|
+
products(first: $first, after: $after) {
|
|
336
|
+
edges {
|
|
337
|
+
node {
|
|
338
|
+
id
|
|
339
|
+
ref
|
|
340
|
+
... on StandardProduct {
|
|
341
|
+
gtin
|
|
342
|
+
attributes {
|
|
343
|
+
name
|
|
344
|
+
value
|
|
345
|
+
}
|
|
346
|
+
}
|
|
347
|
+
... on VariantProduct {
|
|
348
|
+
gtin
|
|
349
|
+
options {
|
|
350
|
+
name
|
|
351
|
+
value
|
|
352
|
+
}
|
|
353
|
+
}
|
|
354
|
+
}
|
|
355
|
+
cursor
|
|
356
|
+
}
|
|
357
|
+
pageInfo {
|
|
358
|
+
hasNextPage
|
|
359
|
+
}
|
|
360
|
+
}
|
|
361
|
+
}
|
|
362
|
+
`,
|
|
363
|
+
variables: { first: 75 },
|
|
364
|
+
pagination: { maxPages: 50 }
|
|
365
|
+
});
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
---
|
|
369
|
+
|
|
370
|
+
## Custom Variable Names
|
|
371
|
+
|
|
372
|
+
SDK detects pagination variables even with custom names.
|
|
373
|
+
|
|
374
|
+
### Pattern Detection
|
|
375
|
+
|
|
376
|
+
SDK recognizes these patterns:
|
|
377
|
+
- `$first` or `$*First` (e.g., `$itemsFirst`)
|
|
378
|
+
- `$after` or `$*After` (e.g., `$itemsAfter`)
|
|
379
|
+
- `$last` or `$*Last` (e.g., `$itemsLast`)
|
|
380
|
+
- `$before` or `$*Before` (e.g., `$itemsBefore`)
|
|
381
|
+
|
|
382
|
+
### Example with Custom Names
|
|
383
|
+
|
|
384
|
+
```typescript
|
|
385
|
+
const result = await client.graphql({
|
|
386
|
+
query: `
|
|
387
|
+
query GetItems($itemsFirst: Int!, $itemsAfter: String) {
|
|
388
|
+
items(first: $itemsFirst, after: $itemsAfter) {
|
|
389
|
+
edges {
|
|
390
|
+
node { id ref }
|
|
391
|
+
cursor
|
|
392
|
+
}
|
|
393
|
+
pageInfo { hasNextPage }
|
|
394
|
+
}
|
|
395
|
+
}
|
|
396
|
+
`,
|
|
397
|
+
variables: { itemsFirst: 100 }, // Custom variable name
|
|
398
|
+
pagination: { maxPages: 50 }
|
|
399
|
+
// SDK automatically detects $itemsFirst and $itemsAfter!
|
|
400
|
+
});
|
|
401
|
+
```
|
|
402
|
+
|
|
403
|
+
---
|
|
404
|
+
|
|
405
|
+
## Filtering with Pagination
|
|
406
|
+
|
|
407
|
+
Combine filters with pagination for targeted queries.
|
|
408
|
+
|
|
409
|
+
### Date Range Filtering
|
|
410
|
+
|
|
411
|
+
```typescript
|
|
412
|
+
const result = await client.graphql({
|
|
413
|
+
query: `
|
|
414
|
+
query GetRecentOrders($first: Int!, $after: String, $from: DateTime!, $to: DateTime!) {
|
|
415
|
+
orders(
|
|
416
|
+
first: $first
|
|
417
|
+
after: $after
|
|
418
|
+
createdOn: { from: $from, to: $to }
|
|
419
|
+
) {
|
|
420
|
+
edges {
|
|
421
|
+
node {
|
|
422
|
+
id
|
|
423
|
+
ref
|
|
424
|
+
status
|
|
425
|
+
createdOn
|
|
426
|
+
}
|
|
427
|
+
cursor
|
|
428
|
+
}
|
|
429
|
+
pageInfo { hasNextPage }
|
|
430
|
+
}
|
|
431
|
+
}
|
|
432
|
+
`,
|
|
433
|
+
variables: {
|
|
434
|
+
first: 100,
|
|
435
|
+
from: '2024-01-01T00:00:00Z',
|
|
436
|
+
to: '2024-12-31T23:59:59Z'
|
|
437
|
+
},
|
|
438
|
+
pagination: { maxRecords: 10000 }
|
|
439
|
+
});
|
|
440
|
+
```
|
|
441
|
+
|
|
442
|
+
### Status Filtering
|
|
443
|
+
|
|
444
|
+
```typescript
|
|
445
|
+
const result = await client.graphql({
|
|
446
|
+
query: `
|
|
447
|
+
query GetActivePositions($first: Int!, $after: String, $status: [String!]) {
|
|
448
|
+
virtualPositions(
|
|
449
|
+
first: $first
|
|
450
|
+
after: $after
|
|
451
|
+
status: $status
|
|
452
|
+
) {
|
|
453
|
+
edges {
|
|
454
|
+
node {
|
|
455
|
+
id
|
|
456
|
+
ref
|
|
457
|
+
productRef
|
|
458
|
+
quantity
|
|
459
|
+
status
|
|
460
|
+
}
|
|
461
|
+
cursor
|
|
462
|
+
}
|
|
463
|
+
pageInfo { hasNextPage }
|
|
464
|
+
}
|
|
465
|
+
}
|
|
466
|
+
`,
|
|
467
|
+
variables: {
|
|
468
|
+
first: 150,
|
|
469
|
+
status: ['ACTIVE', 'AVAILABLE']
|
|
470
|
+
},
|
|
471
|
+
pagination: { maxPages: 100 }
|
|
472
|
+
});
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
### Reference List Filtering
|
|
476
|
+
|
|
477
|
+
```typescript
|
|
478
|
+
const result = await client.graphql({
|
|
479
|
+
query: `
|
|
480
|
+
query GetSpecificProducts($first: Int!, $after: String, $refs: [String!]!) {
|
|
481
|
+
products(
|
|
482
|
+
first: $first
|
|
483
|
+
after: $after
|
|
484
|
+
ref: $refs
|
|
485
|
+
) {
|
|
486
|
+
edges {
|
|
487
|
+
node {
|
|
488
|
+
id
|
|
489
|
+
ref
|
|
490
|
+
type
|
|
491
|
+
}
|
|
492
|
+
cursor
|
|
493
|
+
}
|
|
494
|
+
pageInfo { hasNextPage }
|
|
495
|
+
}
|
|
496
|
+
}
|
|
497
|
+
`,
|
|
498
|
+
variables: {
|
|
499
|
+
first: 100,
|
|
500
|
+
refs: ['PROD-001', 'PROD-002', 'PROD-003']
|
|
501
|
+
},
|
|
502
|
+
pagination: { maxPages: 10 }
|
|
503
|
+
});
|
|
504
|
+
```
|
|
505
|
+
|
|
506
|
+
---
|
|
507
|
+
|
|
508
|
+
## Backward Pagination
|
|
509
|
+
|
|
510
|
+
Paginate in reverse order using `last` and `before`.
|
|
511
|
+
|
|
512
|
+
### Basic Backward Pagination
|
|
513
|
+
|
|
514
|
+
```typescript
|
|
515
|
+
const result = await client.graphql({
|
|
516
|
+
query: `
|
|
517
|
+
query GetLatestItems($last: Int!, $before: String) {
|
|
518
|
+
items(last: $last, before: $before) {
|
|
519
|
+
edges {
|
|
520
|
+
node { id ref createdOn }
|
|
521
|
+
cursor
|
|
522
|
+
}
|
|
523
|
+
pageInfo {
|
|
524
|
+
hasPreviousPage
|
|
525
|
+
}
|
|
526
|
+
}
|
|
527
|
+
}
|
|
528
|
+
`,
|
|
529
|
+
variables: { last: 100 },
|
|
530
|
+
pagination: {
|
|
531
|
+
direction: 'backward', // Required!
|
|
532
|
+
maxPages: 50
|
|
533
|
+
}
|
|
534
|
+
});
|
|
535
|
+
|
|
536
|
+
// Items are in reverse chronological order
|
|
537
|
+
```
|
|
538
|
+
|
|
539
|
+
### Reverse then Forward
|
|
540
|
+
|
|
541
|
+
Get last page first, then paginate backward:
|
|
542
|
+
|
|
543
|
+
```typescript
|
|
544
|
+
// Step 1: Get cursor of last item
|
|
545
|
+
const lastPageResult = await client.graphql({
|
|
546
|
+
query: `
|
|
547
|
+
query GetLastPage($last: Int!) {
|
|
548
|
+
items(last: $last) {
|
|
549
|
+
edges {
|
|
550
|
+
cursor
|
|
551
|
+
node { id ref }
|
|
552
|
+
}
|
|
553
|
+
pageInfo { hasPreviousPage }
|
|
554
|
+
}
|
|
555
|
+
}
|
|
556
|
+
`,
|
|
557
|
+
variables: { last: 1 },
|
|
558
|
+
pagination: { enabled: false } // Disable auto-pagination
|
|
559
|
+
});
|
|
560
|
+
|
|
561
|
+
const lastCursor = lastPageResult.data.items.edges[0]?.cursor;
|
|
562
|
+
|
|
563
|
+
// Step 2: Paginate backward from last cursor
|
|
564
|
+
const backwardResult = await client.graphql({
|
|
565
|
+
query: `
|
|
566
|
+
query GetItemsBackward($last: Int!, $before: String) {
|
|
567
|
+
items(last: $last, before: $before) {
|
|
568
|
+
edges {
|
|
569
|
+
node { id ref }
|
|
570
|
+
cursor
|
|
571
|
+
}
|
|
572
|
+
pageInfo { hasPreviousPage }
|
|
573
|
+
}
|
|
574
|
+
}
|
|
575
|
+
`,
|
|
576
|
+
variables: { last: 100, before: lastCursor },
|
|
577
|
+
pagination: {
|
|
578
|
+
direction: 'backward',
|
|
579
|
+
maxPages: 50
|
|
580
|
+
}
|
|
581
|
+
});
|
|
582
|
+
```
|
|
583
|
+
|
|
584
|
+
---
|
|
585
|
+
|
|
586
|
+
## Complete Real-World Examples
|
|
587
|
+
|
|
588
|
+
### Example 1: Multi-Warehouse Inventory Export
|
|
589
|
+
|
|
590
|
+
```typescript
|
|
591
|
+
async function exportWarehouseInventory(warehouseRefs: string[]) {
|
|
592
|
+
const results = [];
|
|
593
|
+
|
|
594
|
+
for (const warehouseRef of warehouseRefs) {
|
|
595
|
+
console.log(`\nš¦ Exporting inventory for ${warehouseRef}...`);
|
|
596
|
+
|
|
597
|
+
const result = await client.graphql({
|
|
598
|
+
query: `
|
|
599
|
+
query GetWarehouseInventory($first: Int!, $after: String, $groupRef: String!) {
|
|
600
|
+
virtualPositions(
|
|
601
|
+
first: $first
|
|
602
|
+
after: $after
|
|
603
|
+
groupRef: $groupRef
|
|
604
|
+
status: ["ACTIVE", "AVAILABLE"]
|
|
605
|
+
) {
|
|
606
|
+
edges {
|
|
607
|
+
node {
|
|
608
|
+
id
|
|
609
|
+
productRef
|
|
610
|
+
quantity
|
|
611
|
+
groupRef
|
|
612
|
+
status
|
|
613
|
+
}
|
|
614
|
+
cursor
|
|
615
|
+
}
|
|
616
|
+
pageInfo { hasNextPage }
|
|
617
|
+
}
|
|
618
|
+
}
|
|
619
|
+
`,
|
|
620
|
+
variables: {
|
|
621
|
+
first: 150,
|
|
622
|
+
groupRef: warehouseRef
|
|
623
|
+
},
|
|
624
|
+
pagination: {
|
|
625
|
+
maxRecords: 10000,
|
|
626
|
+
onProgress: (page, records) => {
|
|
627
|
+
process.stdout.write(`\r Page ${page}: ${records} positions...`);
|
|
628
|
+
}
|
|
629
|
+
}
|
|
630
|
+
});
|
|
631
|
+
|
|
632
|
+
results.push({
|
|
633
|
+
warehouse: warehouseRef,
|
|
634
|
+
positions: result.data.virtualPositions.edges,
|
|
635
|
+
stats: result.extensions.autoPagination
|
|
636
|
+
});
|
|
637
|
+
|
|
638
|
+
console.log(`\n ā
${result.extensions.autoPagination.totalRecords} positions exported`);
|
|
639
|
+
}
|
|
640
|
+
|
|
641
|
+
return results;
|
|
642
|
+
}
|
|
643
|
+
|
|
644
|
+
// Usage
|
|
645
|
+
const warehouseData = await exportWarehouseInventory(['WH-EAST', 'WH-WEST', 'WH-CENTRAL']);
|
|
646
|
+
```
|
|
647
|
+
|
|
648
|
+
### Example 2: Recent Orders with Items
|
|
649
|
+
|
|
650
|
+
```typescript
|
|
651
|
+
async function getRecentOrdersWithItems(daysSince: number) {
|
|
652
|
+
const fromDate = new Date();
|
|
653
|
+
fromDate.setDate(fromDate.getDate() - daysSince);
|
|
654
|
+
|
|
655
|
+
const result = await client.graphql({
|
|
656
|
+
query: `
|
|
657
|
+
query GetRecentOrders($first: Int!, $after: String, $from: DateTime!) {
|
|
658
|
+
orders(
|
|
659
|
+
first: $first
|
|
660
|
+
after: $after
|
|
661
|
+
createdOn: { from: $from }
|
|
662
|
+
status: ["BOOKED", "ALLOCATED"]
|
|
663
|
+
) {
|
|
664
|
+
edges {
|
|
665
|
+
node {
|
|
666
|
+
id
|
|
667
|
+
ref
|
|
668
|
+
status
|
|
669
|
+
createdOn
|
|
670
|
+
totalPrice
|
|
671
|
+
items {
|
|
672
|
+
edges {
|
|
673
|
+
node {
|
|
674
|
+
id
|
|
675
|
+
productRef
|
|
676
|
+
quantity
|
|
677
|
+
price
|
|
678
|
+
}
|
|
679
|
+
}
|
|
680
|
+
}
|
|
681
|
+
}
|
|
682
|
+
cursor
|
|
683
|
+
}
|
|
684
|
+
pageInfo { hasNextPage }
|
|
685
|
+
}
|
|
686
|
+
}
|
|
687
|
+
`,
|
|
688
|
+
variables: {
|
|
689
|
+
first: 25, // Small page size for complex query
|
|
690
|
+
from: fromDate.toISOString()
|
|
691
|
+
},
|
|
692
|
+
pagination: {
|
|
693
|
+
maxPages: 40,
|
|
694
|
+
maxRecords: 1000,
|
|
695
|
+
delayMs: 100, // Rate limiting for complex query
|
|
696
|
+
onProgress: (page, records) => {
|
|
697
|
+
console.log(`š Fetched ${records} orders across ${page} pages`);
|
|
698
|
+
}
|
|
699
|
+
}
|
|
700
|
+
});
|
|
701
|
+
|
|
702
|
+
return result.data.orders.edges;
|
|
703
|
+
}
|
|
704
|
+
|
|
705
|
+
// Usage
|
|
706
|
+
const orders = await getRecentOrdersWithItems(7); // Last 7 days
|
|
707
|
+
console.log(`Total orders: ${orders.length}`);
|
|
708
|
+
```
|
|
709
|
+
|
|
710
|
+
---
|
|
711
|
+
|
|
712
|
+
## Key Takeaways
|
|
713
|
+
|
|
714
|
+
ā
**Nested connections**: Use `connectionPath` with dot notation
|
|
715
|
+
ā
**Multiple connections**: Specify which to paginate with `connectionPath`
|
|
716
|
+
ā
**Fragments**: Work seamlessly with auto-pagination
|
|
717
|
+
ā
**Aliases**: Update `connectionPath` to match alias
|
|
718
|
+
ā
**Custom variables**: SDK auto-detects `$*First`, `$*After` patterns
|
|
719
|
+
ā
**Filtering**: Combine filters with pagination variables
|
|
720
|
+
ā
**Backward pagination**: Use `direction: 'backward'` with `$last`/`$before`
|
|
721
|
+
|
|
722
|
+
---
|
|
723
|
+
|
|
724
|
+
## Next Steps
|
|
725
|
+
|
|
726
|
+
Learn how to integrate pagination with other SDK services:
|
|
727
|
+
|
|
728
|
+
**Continue to:** [Module 5: SDK Integration ā](./auto-pagination-05-sdk-integration.md)
|
|
729
|
+
|
|
730
|
+
---
|
|
731
|
+
|
|
732
|
+
[ā Back to Index](../../advanced-services/advanced-services-readme.md) | [ā Previous: Configuration](./auto-pagination-03-configuration.md) | [Next: SDK Integration ā](./auto-pagination-05-sdk-integration.md)
|