@fluentcommerce/fc-connect-sdk 0.1.53 → 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.
- package/CHANGELOG.md +30 -2
- package/README.md +39 -0
- package/dist/cjs/auth/index.d.ts +3 -0
- package/dist/cjs/auth/index.js +13 -0
- package/dist/cjs/auth/profile-loader.d.ts +18 -0
- package/dist/cjs/auth/profile-loader.js +208 -0
- package/dist/cjs/client-factory.d.ts +4 -0
- package/dist/cjs/client-factory.js +10 -0
- package/dist/cjs/clients/fluent-client.js +13 -6
- package/dist/cjs/index.d.ts +3 -1
- package/dist/cjs/index.js +8 -2
- package/dist/cjs/utils/pagination-helpers.js +38 -2
- package/dist/cjs/versori/fluent-versori-client.js +11 -5
- package/dist/esm/auth/index.d.ts +3 -0
- package/dist/esm/auth/index.js +2 -0
- package/dist/esm/auth/profile-loader.d.ts +18 -0
- package/dist/esm/auth/profile-loader.js +169 -0
- package/dist/esm/client-factory.d.ts +4 -0
- package/dist/esm/client-factory.js +9 -0
- package/dist/esm/clients/fluent-client.js +13 -6
- package/dist/esm/index.d.ts +3 -1
- package/dist/esm/index.js +2 -1
- 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/dist/types/auth/index.d.ts +3 -0
- package/dist/types/auth/profile-loader.d.ts +18 -0
- package/dist/types/client-factory.d.ts +4 -0
- package/dist/types/index.d.ts +3 -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 -482
- 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
|
@@ -1,423 +1,423 @@
|
|
|
1
|
-
# Module 11: CLI Tools
|
|
2
|
-
|
|
3
|
-
**Level:** Advanced
|
|
4
|
-
**Category:** Command Line
|
|
5
|
-
|
|
6
|
-
## Overview
|
|
7
|
-
|
|
8
|
-
The SDK includes powerful CLI tools for schema introspection, mapping generation, validation, and coverage analysis to streamline development workflows.
|
|
9
|
-
|
|
10
|
-
## Table of Contents
|
|
11
|
-
|
|
12
|
-
- [Main CLI](#main-cli)
|
|
13
|
-
- [generate-mutation-mapping](#generate-mutation-mapping)
|
|
14
|
-
- [generate-query-mapping](#generate-query-mapping)
|
|
15
|
-
- [analyze-source-structure](#analyze-source-structure)
|
|
16
|
-
- [introspect-schema](#introspect-schema)
|
|
17
|
-
- [validate-schema](#validate-schema)
|
|
18
|
-
- [analyze-coverage](#analyze-coverage)
|
|
19
|
-
- [CLI Workflow Example](#cli-workflow-example)
|
|
20
|
-
- [See Also](#see-also)
|
|
21
|
-
|
|
22
|
-
---
|
|
23
|
-
|
|
24
|
-
## Main CLI
|
|
25
|
-
|
|
26
|
-
Access all SDK command-line tools through the main CLI entry point.
|
|
27
|
-
|
|
28
|
-
```bash
|
|
29
|
-
# Show help
|
|
30
|
-
npx fc-connect help
|
|
31
|
-
|
|
32
|
-
# Show version
|
|
33
|
-
npx fc-connect version
|
|
34
|
-
|
|
35
|
-
# Run specific command
|
|
36
|
-
npx fc-connect <command> [options]
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
**Available Commands:**
|
|
40
|
-
- `generate-mutation-mapping` - Generate mapping template for mutations (ingest)
|
|
41
|
-
- `generate-query-mapping` - Generate mapping template for queries (extract)
|
|
42
|
-
- `analyze-source-structure` - Analyze source files (XML/JSON/CSV/Parquet) and suggest mapping paths
|
|
43
|
-
- `introspect-schema` - Fetch and cache GraphQL schema
|
|
44
|
-
- `validate-schema` - Validate mapping against schema
|
|
45
|
-
- `analyze-coverage` - Analyze field coverage in mappings
|
|
46
|
-
|
|
47
|
-
## generate-mutation-mapping
|
|
48
|
-
|
|
49
|
-
Generate mapping templates for GraphQL mutations (ingest direction).
|
|
50
|
-
|
|
51
|
-
**Usage:**
|
|
52
|
-
```bash
|
|
53
|
-
npx fc-connect generate-mutation-mapping [OPTIONS]
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
**Options:**
|
|
57
|
-
- `-f, --file <path>` - GraphQL mutation file path
|
|
58
|
-
- `-m, --mutation <string>` - Inline GraphQL mutation string
|
|
59
|
-
- `-e, --endpoint <url>` - GraphQL endpoint for schema introspection
|
|
60
|
-
- `-s, --schema <path>` - JSON schema introspection file (alternative to endpoint)
|
|
61
|
-
- `-o, --output <path>` - Output file path (defaults to stdout)
|
|
62
|
-
- `--format <xml|json|csv>` - Source data format (default: xml)
|
|
63
|
-
- `-p, --prefix <string>` - Source path prefix (e.g., $radial., $source.)
|
|
64
|
-
- `--nodes` - Include nodes configuration for nested data extraction
|
|
65
|
-
- `--node-config <path>` - JSON file with node configuration
|
|
66
|
-
- `--custom-resolvers` - Generate custom resolver placeholders
|
|
67
|
-
- `-h, --help` - Show help message
|
|
68
|
-
|
|
69
|
-
**Examples:**
|
|
70
|
-
|
|
71
|
-
```bash
|
|
72
|
-
# Basic: Generate from file with schema introspection
|
|
73
|
-
npx fc-connect generate-mutation-mapping \
|
|
74
|
-
--file ./mutations/createOrder.graphql \
|
|
75
|
-
--endpoint https://api.fluentcommerce.com/graphql
|
|
76
|
-
|
|
77
|
-
# SFCC-style with nodes and prefix
|
|
78
|
-
npx fc-connect generate-mutation-mapping \
|
|
79
|
-
--file ./mutations/createOrder.graphql \
|
|
80
|
-
--endpoint https://api.fluentcommerce.com/graphql \
|
|
81
|
-
--format xml \
|
|
82
|
-
--prefix '$radial.' \
|
|
83
|
-
--nodes \
|
|
84
|
-
--node-config ./nodes/radial-config.json \
|
|
85
|
-
--output ./mappings/createOrder-mapping.json
|
|
86
|
-
|
|
87
|
-
# Using pre-fetched schema (faster)
|
|
88
|
-
npx fc-connect generate-mutation-mapping \
|
|
89
|
-
--file ./mutations/createOrder.graphql \
|
|
90
|
-
--schema ./fluent-schema.json \
|
|
91
|
-
--output ./mappings/createOrder-mapping.json
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
**Output:**
|
|
95
|
-
Generates a JSON mapping template with:
|
|
96
|
-
- `direction`: "ingest"
|
|
97
|
-
- `mutation`: operation name
|
|
98
|
-
- `fields`: INPUT field mappings with placeholders
|
|
99
|
-
- `nodes`: (optional) nested data extraction config
|
|
100
|
-
- All required vs optional fields marked
|
|
101
|
-
- Type information in comments
|
|
102
|
-
|
|
103
|
-
## generate-query-mapping
|
|
104
|
-
|
|
105
|
-
Generate mapping templates for GraphQL queries (extraction direction).
|
|
106
|
-
|
|
107
|
-
**Usage:**
|
|
108
|
-
```bash
|
|
109
|
-
npx fc-connect generate-query-mapping [OPTIONS]
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
**Options:**
|
|
113
|
-
- `-f, --file <path>` - GraphQL query file path
|
|
114
|
-
- `-q, --query <string>` - Inline GraphQL query string
|
|
115
|
-
- `-e, --endpoint <url>` - GraphQL endpoint for schema introspection
|
|
116
|
-
- `-s, --schema <path>` - JSON schema introspection file
|
|
117
|
-
- `-o, --output <path>` - Output file path
|
|
118
|
-
- `--format <csv|json|xml>` - Target output format (default: json)
|
|
119
|
-
- `-h, --help` - Show help message
|
|
120
|
-
|
|
121
|
-
**Examples:**
|
|
122
|
-
|
|
123
|
-
```bash
|
|
124
|
-
# Basic usage
|
|
125
|
-
npx fc-connect generate-query-mapping \
|
|
126
|
-
--file ./queries/getOrders.graphql \
|
|
127
|
-
--endpoint https://api.fluentcommerce.com/graphql \
|
|
128
|
-
--format csv \
|
|
129
|
-
--output ./mappings/extract-orders.json
|
|
130
|
-
|
|
131
|
-
# With output format configuration
|
|
132
|
-
npx fc-connect generate-query-mapping \
|
|
133
|
-
--query "query GetProducts { products { edges { node { id ref name } } } }" \
|
|
134
|
-
--schema ./schema.json \
|
|
135
|
-
--format json \
|
|
136
|
-
--output ./mappings/extract-products.json
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
## introspect-schema
|
|
140
|
-
|
|
141
|
-
Fetch and cache GraphQL schema for offline use.
|
|
142
|
-
|
|
143
|
-
**Usage:**
|
|
144
|
-
```bash
|
|
145
|
-
npx fc-connect introspect-schema [OPTIONS]
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
**Options:**
|
|
149
|
-
- `-e, --endpoint <url>` - GraphQL endpoint URL (required)
|
|
150
|
-
- `-o, --output <path>` - Output file path for schema JSON (required)
|
|
151
|
-
- `--header <header>` - Custom headers (can be used multiple times)
|
|
152
|
-
- `-h, --help` - Show help message
|
|
153
|
-
|
|
154
|
-
**Examples:**
|
|
155
|
-
|
|
156
|
-
```bash
|
|
157
|
-
# Introspect and save schema
|
|
158
|
-
npx fc-connect introspect-schema \
|
|
159
|
-
--endpoint https://api.fluentcommerce.com/graphql \
|
|
160
|
-
--output ./schema/fluent-schema.json
|
|
161
|
-
|
|
162
|
-
# With authentication
|
|
163
|
-
npx fc-connect introspect-schema \
|
|
164
|
-
--endpoint https://api.fluentcommerce.com/graphql \
|
|
165
|
-
--header "Authorization: Bearer YOUR_TOKEN" \
|
|
166
|
-
--output ./schema/fluent-schema.json
|
|
167
|
-
|
|
168
|
-
# Multiple custom headers
|
|
169
|
-
npx fc-connect introspect-schema \
|
|
170
|
-
--endpoint https://api.fluentcommerce.com/graphql \
|
|
171
|
-
--header "Authorization: Bearer YOUR_TOKEN" \
|
|
172
|
-
--header "X-Custom-Header: value" \
|
|
173
|
-
--output ./schema/fluent-schema.json
|
|
174
|
-
```
|
|
175
|
-
|
|
176
|
-
**Benefits:**
|
|
177
|
-
- Cache schema for offline development
|
|
178
|
-
- Faster mapping generation (no network calls)
|
|
179
|
-
- Version control your schema snapshots
|
|
180
|
-
- Consistent schema across team
|
|
181
|
-
|
|
182
|
-
## validate-schema
|
|
183
|
-
|
|
184
|
-
Validate your mapping configurations against the GraphQL schema.
|
|
185
|
-
|
|
186
|
-
**Usage:**
|
|
187
|
-
```bash
|
|
188
|
-
npx fc-connect validate-schema [OPTIONS]
|
|
189
|
-
```
|
|
190
|
-
|
|
191
|
-
**Options:**
|
|
192
|
-
- `-m, --mapping <path>` - Mapping file or glob pattern (required)
|
|
193
|
-
- `-s, --schema <path>` - GraphQL schema JSON file (required)
|
|
194
|
-
- `--strict` - Enable strict validation mode
|
|
195
|
-
- `-h, --help` - Show help message
|
|
196
|
-
|
|
197
|
-
**Examples:**
|
|
198
|
-
|
|
199
|
-
```bash
|
|
200
|
-
# Validate single mapping
|
|
201
|
-
npx fc-connect validate-schema \
|
|
202
|
-
--mapping ./mappings/createOrder.json \
|
|
203
|
-
--schema ./schema/fluent-schema.json
|
|
204
|
-
|
|
205
|
-
# Validate multiple mappings with glob pattern
|
|
206
|
-
npx fc-connect validate-schema \
|
|
207
|
-
--mapping "./mappings/*.json" \
|
|
208
|
-
--schema ./schema/fluent-schema.json
|
|
209
|
-
|
|
210
|
-
# Strict mode (fails on warnings)
|
|
211
|
-
npx fc-connect validate-schema \
|
|
212
|
-
--mapping ./mappings/createOrder.json \
|
|
213
|
-
--schema ./schema/fluent-schema.json \
|
|
214
|
-
--strict
|
|
215
|
-
```
|
|
216
|
-
|
|
217
|
-
**Validation Checks:**
|
|
218
|
-
- Required fields are mapped
|
|
219
|
-
- Field types match schema
|
|
220
|
-
- Array configurations are correct
|
|
221
|
-
- Transformation functions are valid
|
|
222
|
-
- Node configurations are correct
|
|
223
|
-
|
|
224
|
-
## analyze-source-structure
|
|
225
|
-
|
|
226
|
-
Analyze source files (XML/JSON/CSV/Parquet) to understand their structure and generate mapping configuration suggestions with automatic resolver detection.
|
|
227
|
-
|
|
228
|
-
**Usage:**
|
|
229
|
-
```bash
|
|
230
|
-
npx fc-connect analyze-source-structure [OPTIONS]
|
|
231
|
-
```
|
|
232
|
-
|
|
233
|
-
**Options:**
|
|
234
|
-
- `-f, --file <path>` - Source file to analyze (required)
|
|
235
|
-
- `--format <xml|json|csv|parquet>` - File format (auto-detected from extension)
|
|
236
|
-
- `-o, --output <path>` - Output file path for mapping template (optional)
|
|
237
|
-
- `--show-structure` - Show parsed JavaScript object structure
|
|
238
|
-
- `--show-json` - Show parsed structure as formatted JSON
|
|
239
|
-
- `--direction <ingest|extract>` - Generate mapping for ingest or extract direction
|
|
240
|
-
- `--mapper <universal|graphql>` - Generate mapping for universal or graphql mapper
|
|
241
|
-
- `--markdown [path]` - Generate comprehensive markdown documentation (default: `analysis-documentation.md`)
|
|
242
|
-
- `--docs [path]` - Alias for `--markdown`
|
|
243
|
-
- `-h, --help` - Show help message
|
|
244
|
-
|
|
245
|
-
**Examples:**
|
|
246
|
-
```bash
|
|
247
|
-
# Analyze XML file
|
|
248
|
-
npx fc-connect analyze-source-structure \
|
|
249
|
-
--file ./order.xml \
|
|
250
|
-
--format xml \
|
|
251
|
-
--show-structure \
|
|
252
|
-
--output ./order-mapping.json
|
|
253
|
-
|
|
254
|
-
# Generate markdown documentation
|
|
255
|
-
npx fc-connect analyze-source-structure \
|
|
256
|
-
--file ./inventory.csv \
|
|
257
|
-
--format csv \
|
|
258
|
-
--markdown ./docs/inventory-analysis.md
|
|
259
|
-
|
|
260
|
-
# Analyze and generate template with resolvers
|
|
261
|
-
npx fc-connect analyze-source-structure \
|
|
262
|
-
--file ./products.json \
|
|
263
|
-
--output ./product-mapping.json
|
|
264
|
-
```
|
|
265
|
-
|
|
266
|
-
**Key Features:**
|
|
267
|
-
- ✅ **Automatic Resolver Detection** - Detects data types and includes appropriate resolvers (`sdk.parseInt`, `sdk.parseDate`, `sdk.trim`, etc.)
|
|
268
|
-
- ✅ **XML Attribute Parsing** - Automatically detects and maps XML attributes (e.g., `@sku`, `@id`)
|
|
269
|
-
- ✅ **Array Detection** - Identifies arrays and generates item-relative field paths
|
|
270
|
-
- ✅ **Markdown Documentation** - Generate comprehensive analysis documentation
|
|
271
|
-
|
|
272
|
-
**Note:** Resolvers are automatically included in generated mapping templates based on detected data types. See [Module 12: Analyze Source Structure](./api-reference-12-analyze-source-structure.md) for complete documentation.
|
|
273
|
-
|
|
274
|
-
## analyze-coverage
|
|
275
|
-
|
|
276
|
-
Analyze mapping field coverage and identify gaps with detailed reports.
|
|
277
|
-
|
|
278
|
-
**Usage:**
|
|
279
|
-
```bash
|
|
280
|
-
npx fc-connect analyze-coverage [OPTIONS]
|
|
281
|
-
```
|
|
282
|
-
|
|
283
|
-
**Options:**
|
|
284
|
-
- `-m, --mapping <path>` - Mapping file or glob pattern (required)
|
|
285
|
-
- `-s, --schema <path>` - GraphQL schema JSON file (required)
|
|
286
|
-
- `--min-coverage <percent>` - Minimum total coverage % (fails if below)
|
|
287
|
-
- `--min-required <percent>` - Minimum required field coverage % (fails if below)
|
|
288
|
-
- `--show-missing` - Show detailed list of missing fields
|
|
289
|
-
- `--format <table|json|markdown>` - Output format (default: table)
|
|
290
|
-
- `-o, --output <path>` - Save report to file
|
|
291
|
-
- `-h, --help` - Show help message
|
|
292
|
-
|
|
293
|
-
**Examples:**
|
|
294
|
-
|
|
295
|
-
```bash
|
|
296
|
-
# Basic coverage report
|
|
297
|
-
npx fc-connect analyze-coverage \
|
|
298
|
-
--mapping ./mappings/createOrder.json \
|
|
299
|
-
--schema ./schema/fluent-schema.json
|
|
300
|
-
|
|
301
|
-
# With coverage thresholds (for CI/CD)
|
|
302
|
-
npx fc-connect analyze-coverage \
|
|
303
|
-
--mapping ./mappings/createOrder.json \
|
|
304
|
-
--schema ./schema/fluent-schema.json \
|
|
305
|
-
--min-coverage 80 \
|
|
306
|
-
--min-required 100
|
|
307
|
-
|
|
308
|
-
# Show missing fields
|
|
309
|
-
npx fc-connect analyze-coverage \
|
|
310
|
-
--mapping ./mappings/createOrder.json \
|
|
311
|
-
--schema ./schema/fluent-schema.json \
|
|
312
|
-
--show-missing
|
|
313
|
-
|
|
314
|
-
# JSON output for automation
|
|
315
|
-
npx fc-connect analyze-coverage \
|
|
316
|
-
--mapping ./mappings/*.json \
|
|
317
|
-
--schema ./schema/fluent-schema.json \
|
|
318
|
-
--format json \
|
|
319
|
-
--output coverage-report.json
|
|
320
|
-
|
|
321
|
-
# Markdown report for documentation
|
|
322
|
-
npx fc-connect analyze-coverage \
|
|
323
|
-
--mapping ./mappings/createOrder.json \
|
|
324
|
-
--schema ./schema/fluent-schema.json \
|
|
325
|
-
--format markdown \
|
|
326
|
-
--output ./docs/coverage.md
|
|
327
|
-
```
|
|
328
|
-
|
|
329
|
-
**Coverage Metrics:**
|
|
330
|
-
- **Required Coverage**: % of required fields that are mapped
|
|
331
|
-
- **Optional Coverage**: % of optional fields that are mapped
|
|
332
|
-
- **Total Coverage**: % of all fields (required + optional) that are mapped
|
|
333
|
-
|
|
334
|
-
**Example Output:**
|
|
335
|
-
```
|
|
336
|
-
╔═══════════════════════════════════════════════════════════════════════╗
|
|
337
|
-
║ Coverage Report: createOrder-mapping.json ║
|
|
338
|
-
╠═══════════════════════════════════════════════════════════════════════╣
|
|
339
|
-
║ Operation: createOrder ║
|
|
340
|
-
║ Direction: ingest ║
|
|
341
|
-
╠═══════════════════════════════════════════════════════════════════════╣
|
|
342
|
-
║ Required Fields: 10/10 (100%) ✅ ║
|
|
343
|
-
║ Optional Fields: 5/20 (25%) ║
|
|
344
|
-
║ Total Coverage: 15/30 (50%) ║
|
|
345
|
-
╚═══════════════════════════════════════════════════════════════════════╝
|
|
346
|
-
```
|
|
347
|
-
|
|
348
|
-
**Exit Codes:**
|
|
349
|
-
- `0` - Coverage meets thresholds
|
|
350
|
-
- `1` - Coverage below thresholds
|
|
351
|
-
- `2` - Invalid arguments or file errors
|
|
352
|
-
|
|
353
|
-
**CI/CD Integration:**
|
|
354
|
-
|
|
355
|
-
```yaml
|
|
356
|
-
# GitHub Actions - Enforce coverage thresholds
|
|
357
|
-
- name: Check mapping coverage
|
|
358
|
-
run: |
|
|
359
|
-
npx fc-connect analyze-coverage \
|
|
360
|
-
--mapping ./mappings/*.json \
|
|
361
|
-
--schema ./schema.json \
|
|
362
|
-
--min-coverage 80 \
|
|
363
|
-
--min-required 100
|
|
364
|
-
```
|
|
365
|
-
|
|
366
|
-
```bash
|
|
367
|
-
# Pre-commit hook
|
|
368
|
-
#!/bin/bash
|
|
369
|
-
npx fc-connect analyze-coverage \
|
|
370
|
-
--mapping ./mappings/*.json \
|
|
371
|
-
--schema ./schema.json \
|
|
372
|
-
--min-required 100 \
|
|
373
|
-
|| { echo "❌ Required fields not fully mapped"; exit 1; }
|
|
374
|
-
```
|
|
375
|
-
|
|
376
|
-
## CLI Workflow Example
|
|
377
|
-
|
|
378
|
-
Complete workflow for creating and validating mappings:
|
|
379
|
-
|
|
380
|
-
```bash
|
|
381
|
-
# 1. Introspect and cache the schema
|
|
382
|
-
npx fc-connect introspect-schema \
|
|
383
|
-
--endpoint https://api.fluentcommerce.com/graphql \
|
|
384
|
-
--output ./schema/fluent-schema.json
|
|
385
|
-
|
|
386
|
-
# 2. Generate mutation mapping template
|
|
387
|
-
npx fc-connect generate-mutation-mapping \
|
|
388
|
-
--file ./mutations/createOrder.graphql \
|
|
389
|
-
--schema ./schema/fluent-schema.json \
|
|
390
|
-
--output ./mappings/createOrder.json
|
|
391
|
-
|
|
392
|
-
# 3. Edit the mapping file (replace TODO placeholders)
|
|
393
|
-
# vim ./mappings/createOrder.json
|
|
394
|
-
|
|
395
|
-
# 4. Validate the mapping
|
|
396
|
-
npx fc-connect validate-schema \
|
|
397
|
-
--mapping ./mappings/createOrder.json \
|
|
398
|
-
--schema ./schema/fluent-schema.json
|
|
399
|
-
|
|
400
|
-
# 5. Check coverage
|
|
401
|
-
npx fc-connect analyze-coverage \
|
|
402
|
-
--mapping ./mappings/createOrder.json \
|
|
403
|
-
--schema ./schema/fluent-schema.json \
|
|
404
|
-
--show-missing \
|
|
405
|
-
--min-required 100
|
|
406
|
-
|
|
407
|
-
# 6. Generate coverage report for documentation
|
|
408
|
-
npx fc-connect analyze-coverage \
|
|
409
|
-
--mapping ./mappings/*.json \
|
|
410
|
-
--schema ./schema/fluent-schema.json \
|
|
411
|
-
--format markdown \
|
|
412
|
-
--output ./docs/mapping-coverage.md
|
|
413
|
-
```
|
|
414
|
-
|
|
415
|
-
## See Also
|
|
416
|
-
|
|
417
|
-
- [Module 05: Services](./api-reference-05-services.md#universal-mapper) - Using generated mappings
|
|
418
|
-
- [Getting Started Guide](../../../00-START-HERE/getting-started.md) - Basic setup
|
|
419
|
-
- [CLI Tools Documentation](../../../../bin/readme.md) - Complete CLI documentation
|
|
420
|
-
|
|
421
|
-
---
|
|
422
|
-
|
|
423
|
-
**[← Previous: Module 10 - Utilities](./api-reference-10-utilities.md)** | **[API Reference Home](../api-reference-readme.md)** | **[Next: Module 12 - Testing →](./api-reference-12-testing.md)**
|
|
1
|
+
# Module 11: CLI Tools
|
|
2
|
+
|
|
3
|
+
**Level:** Advanced
|
|
4
|
+
**Category:** Command Line
|
|
5
|
+
|
|
6
|
+
## Overview
|
|
7
|
+
|
|
8
|
+
The SDK includes powerful CLI tools for schema introspection, mapping generation, validation, and coverage analysis to streamline development workflows.
|
|
9
|
+
|
|
10
|
+
## Table of Contents
|
|
11
|
+
|
|
12
|
+
- [Main CLI](#main-cli)
|
|
13
|
+
- [generate-mutation-mapping](#generate-mutation-mapping)
|
|
14
|
+
- [generate-query-mapping](#generate-query-mapping)
|
|
15
|
+
- [analyze-source-structure](#analyze-source-structure)
|
|
16
|
+
- [introspect-schema](#introspect-schema)
|
|
17
|
+
- [validate-schema](#validate-schema)
|
|
18
|
+
- [analyze-coverage](#analyze-coverage)
|
|
19
|
+
- [CLI Workflow Example](#cli-workflow-example)
|
|
20
|
+
- [See Also](#see-also)
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Main CLI
|
|
25
|
+
|
|
26
|
+
Access all SDK command-line tools through the main CLI entry point.
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
# Show help
|
|
30
|
+
npx fc-connect help
|
|
31
|
+
|
|
32
|
+
# Show version
|
|
33
|
+
npx fc-connect version
|
|
34
|
+
|
|
35
|
+
# Run specific command
|
|
36
|
+
npx fc-connect <command> [options]
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
**Available Commands:**
|
|
40
|
+
- `generate-mutation-mapping` - Generate mapping template for mutations (ingest)
|
|
41
|
+
- `generate-query-mapping` - Generate mapping template for queries (extract)
|
|
42
|
+
- `analyze-source-structure` - Analyze source files (XML/JSON/CSV/Parquet) and suggest mapping paths
|
|
43
|
+
- `introspect-schema` - Fetch and cache GraphQL schema
|
|
44
|
+
- `validate-schema` - Validate mapping against schema
|
|
45
|
+
- `analyze-coverage` - Analyze field coverage in mappings
|
|
46
|
+
|
|
47
|
+
## generate-mutation-mapping
|
|
48
|
+
|
|
49
|
+
Generate mapping templates for GraphQL mutations (ingest direction).
|
|
50
|
+
|
|
51
|
+
**Usage:**
|
|
52
|
+
```bash
|
|
53
|
+
npx fc-connect generate-mutation-mapping [OPTIONS]
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
**Options:**
|
|
57
|
+
- `-f, --file <path>` - GraphQL mutation file path
|
|
58
|
+
- `-m, --mutation <string>` - Inline GraphQL mutation string
|
|
59
|
+
- `-e, --endpoint <url>` - GraphQL endpoint for schema introspection
|
|
60
|
+
- `-s, --schema <path>` - JSON schema introspection file (alternative to endpoint)
|
|
61
|
+
- `-o, --output <path>` - Output file path (defaults to stdout)
|
|
62
|
+
- `--format <xml|json|csv>` - Source data format (default: xml)
|
|
63
|
+
- `-p, --prefix <string>` - Source path prefix (e.g., $radial., $source.)
|
|
64
|
+
- `--nodes` - Include nodes configuration for nested data extraction
|
|
65
|
+
- `--node-config <path>` - JSON file with node configuration
|
|
66
|
+
- `--custom-resolvers` - Generate custom resolver placeholders
|
|
67
|
+
- `-h, --help` - Show help message
|
|
68
|
+
|
|
69
|
+
**Examples:**
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
# Basic: Generate from file with schema introspection
|
|
73
|
+
npx fc-connect generate-mutation-mapping \
|
|
74
|
+
--file ./mutations/createOrder.graphql \
|
|
75
|
+
--endpoint https://api.fluentcommerce.com/graphql
|
|
76
|
+
|
|
77
|
+
# SFCC-style with nodes and prefix
|
|
78
|
+
npx fc-connect generate-mutation-mapping \
|
|
79
|
+
--file ./mutations/createOrder.graphql \
|
|
80
|
+
--endpoint https://api.fluentcommerce.com/graphql \
|
|
81
|
+
--format xml \
|
|
82
|
+
--prefix '$radial.' \
|
|
83
|
+
--nodes \
|
|
84
|
+
--node-config ./nodes/radial-config.json \
|
|
85
|
+
--output ./mappings/createOrder-mapping.json
|
|
86
|
+
|
|
87
|
+
# Using pre-fetched schema (faster)
|
|
88
|
+
npx fc-connect generate-mutation-mapping \
|
|
89
|
+
--file ./mutations/createOrder.graphql \
|
|
90
|
+
--schema ./fluent-schema.json \
|
|
91
|
+
--output ./mappings/createOrder-mapping.json
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
**Output:**
|
|
95
|
+
Generates a JSON mapping template with:
|
|
96
|
+
- `direction`: "ingest"
|
|
97
|
+
- `mutation`: operation name
|
|
98
|
+
- `fields`: INPUT field mappings with placeholders
|
|
99
|
+
- `nodes`: (optional) nested data extraction config
|
|
100
|
+
- All required vs optional fields marked
|
|
101
|
+
- Type information in comments
|
|
102
|
+
|
|
103
|
+
## generate-query-mapping
|
|
104
|
+
|
|
105
|
+
Generate mapping templates for GraphQL queries (extraction direction).
|
|
106
|
+
|
|
107
|
+
**Usage:**
|
|
108
|
+
```bash
|
|
109
|
+
npx fc-connect generate-query-mapping [OPTIONS]
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
**Options:**
|
|
113
|
+
- `-f, --file <path>` - GraphQL query file path
|
|
114
|
+
- `-q, --query <string>` - Inline GraphQL query string
|
|
115
|
+
- `-e, --endpoint <url>` - GraphQL endpoint for schema introspection
|
|
116
|
+
- `-s, --schema <path>` - JSON schema introspection file
|
|
117
|
+
- `-o, --output <path>` - Output file path
|
|
118
|
+
- `--format <csv|json|xml>` - Target output format (default: json)
|
|
119
|
+
- `-h, --help` - Show help message
|
|
120
|
+
|
|
121
|
+
**Examples:**
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
# Basic usage
|
|
125
|
+
npx fc-connect generate-query-mapping \
|
|
126
|
+
--file ./queries/getOrders.graphql \
|
|
127
|
+
--endpoint https://api.fluentcommerce.com/graphql \
|
|
128
|
+
--format csv \
|
|
129
|
+
--output ./mappings/extract-orders.json
|
|
130
|
+
|
|
131
|
+
# With output format configuration
|
|
132
|
+
npx fc-connect generate-query-mapping \
|
|
133
|
+
--query "query GetProducts { products { edges { node { id ref name } } } }" \
|
|
134
|
+
--schema ./schema.json \
|
|
135
|
+
--format json \
|
|
136
|
+
--output ./mappings/extract-products.json
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
## introspect-schema
|
|
140
|
+
|
|
141
|
+
Fetch and cache GraphQL schema for offline use.
|
|
142
|
+
|
|
143
|
+
**Usage:**
|
|
144
|
+
```bash
|
|
145
|
+
npx fc-connect introspect-schema [OPTIONS]
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
**Options:**
|
|
149
|
+
- `-e, --endpoint <url>` - GraphQL endpoint URL (required)
|
|
150
|
+
- `-o, --output <path>` - Output file path for schema JSON (required)
|
|
151
|
+
- `--header <header>` - Custom headers (can be used multiple times)
|
|
152
|
+
- `-h, --help` - Show help message
|
|
153
|
+
|
|
154
|
+
**Examples:**
|
|
155
|
+
|
|
156
|
+
```bash
|
|
157
|
+
# Introspect and save schema
|
|
158
|
+
npx fc-connect introspect-schema \
|
|
159
|
+
--endpoint https://api.fluentcommerce.com/graphql \
|
|
160
|
+
--output ./schema/fluent-schema.json
|
|
161
|
+
|
|
162
|
+
# With authentication
|
|
163
|
+
npx fc-connect introspect-schema \
|
|
164
|
+
--endpoint https://api.fluentcommerce.com/graphql \
|
|
165
|
+
--header "Authorization: Bearer YOUR_TOKEN" \
|
|
166
|
+
--output ./schema/fluent-schema.json
|
|
167
|
+
|
|
168
|
+
# Multiple custom headers
|
|
169
|
+
npx fc-connect introspect-schema \
|
|
170
|
+
--endpoint https://api.fluentcommerce.com/graphql \
|
|
171
|
+
--header "Authorization: Bearer YOUR_TOKEN" \
|
|
172
|
+
--header "X-Custom-Header: value" \
|
|
173
|
+
--output ./schema/fluent-schema.json
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
**Benefits:**
|
|
177
|
+
- Cache schema for offline development
|
|
178
|
+
- Faster mapping generation (no network calls)
|
|
179
|
+
- Version control your schema snapshots
|
|
180
|
+
- Consistent schema across team
|
|
181
|
+
|
|
182
|
+
## validate-schema
|
|
183
|
+
|
|
184
|
+
Validate your mapping configurations against the GraphQL schema.
|
|
185
|
+
|
|
186
|
+
**Usage:**
|
|
187
|
+
```bash
|
|
188
|
+
npx fc-connect validate-schema [OPTIONS]
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
**Options:**
|
|
192
|
+
- `-m, --mapping <path>` - Mapping file or glob pattern (required)
|
|
193
|
+
- `-s, --schema <path>` - GraphQL schema JSON file (required)
|
|
194
|
+
- `--strict` - Enable strict validation mode
|
|
195
|
+
- `-h, --help` - Show help message
|
|
196
|
+
|
|
197
|
+
**Examples:**
|
|
198
|
+
|
|
199
|
+
```bash
|
|
200
|
+
# Validate single mapping
|
|
201
|
+
npx fc-connect validate-schema \
|
|
202
|
+
--mapping ./mappings/createOrder.json \
|
|
203
|
+
--schema ./schema/fluent-schema.json
|
|
204
|
+
|
|
205
|
+
# Validate multiple mappings with glob pattern
|
|
206
|
+
npx fc-connect validate-schema \
|
|
207
|
+
--mapping "./mappings/*.json" \
|
|
208
|
+
--schema ./schema/fluent-schema.json
|
|
209
|
+
|
|
210
|
+
# Strict mode (fails on warnings)
|
|
211
|
+
npx fc-connect validate-schema \
|
|
212
|
+
--mapping ./mappings/createOrder.json \
|
|
213
|
+
--schema ./schema/fluent-schema.json \
|
|
214
|
+
--strict
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
**Validation Checks:**
|
|
218
|
+
- Required fields are mapped
|
|
219
|
+
- Field types match schema
|
|
220
|
+
- Array configurations are correct
|
|
221
|
+
- Transformation functions are valid
|
|
222
|
+
- Node configurations are correct
|
|
223
|
+
|
|
224
|
+
## analyze-source-structure
|
|
225
|
+
|
|
226
|
+
Analyze source files (XML/JSON/CSV/Parquet) to understand their structure and generate mapping configuration suggestions with automatic resolver detection.
|
|
227
|
+
|
|
228
|
+
**Usage:**
|
|
229
|
+
```bash
|
|
230
|
+
npx fc-connect analyze-source-structure [OPTIONS]
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
**Options:**
|
|
234
|
+
- `-f, --file <path>` - Source file to analyze (required)
|
|
235
|
+
- `--format <xml|json|csv|parquet>` - File format (auto-detected from extension)
|
|
236
|
+
- `-o, --output <path>` - Output file path for mapping template (optional)
|
|
237
|
+
- `--show-structure` - Show parsed JavaScript object structure
|
|
238
|
+
- `--show-json` - Show parsed structure as formatted JSON
|
|
239
|
+
- `--direction <ingest|extract>` - Generate mapping for ingest or extract direction
|
|
240
|
+
- `--mapper <universal|graphql>` - Generate mapping for universal or graphql mapper
|
|
241
|
+
- `--markdown [path]` - Generate comprehensive markdown documentation (default: `analysis-documentation.md`)
|
|
242
|
+
- `--docs [path]` - Alias for `--markdown`
|
|
243
|
+
- `-h, --help` - Show help message
|
|
244
|
+
|
|
245
|
+
**Examples:**
|
|
246
|
+
```bash
|
|
247
|
+
# Analyze XML file
|
|
248
|
+
npx fc-connect analyze-source-structure \
|
|
249
|
+
--file ./order.xml \
|
|
250
|
+
--format xml \
|
|
251
|
+
--show-structure \
|
|
252
|
+
--output ./order-mapping.json
|
|
253
|
+
|
|
254
|
+
# Generate markdown documentation
|
|
255
|
+
npx fc-connect analyze-source-structure \
|
|
256
|
+
--file ./inventory.csv \
|
|
257
|
+
--format csv \
|
|
258
|
+
--markdown ./docs/inventory-analysis.md
|
|
259
|
+
|
|
260
|
+
# Analyze and generate template with resolvers
|
|
261
|
+
npx fc-connect analyze-source-structure \
|
|
262
|
+
--file ./products.json \
|
|
263
|
+
--output ./product-mapping.json
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
**Key Features:**
|
|
267
|
+
- ✅ **Automatic Resolver Detection** - Detects data types and includes appropriate resolvers (`sdk.parseInt`, `sdk.parseDate`, `sdk.trim`, etc.)
|
|
268
|
+
- ✅ **XML Attribute Parsing** - Automatically detects and maps XML attributes (e.g., `@sku`, `@id`)
|
|
269
|
+
- ✅ **Array Detection** - Identifies arrays and generates item-relative field paths
|
|
270
|
+
- ✅ **Markdown Documentation** - Generate comprehensive analysis documentation
|
|
271
|
+
|
|
272
|
+
**Note:** Resolvers are automatically included in generated mapping templates based on detected data types. See [Module 12: Analyze Source Structure](./api-reference-12-analyze-source-structure.md) for complete documentation.
|
|
273
|
+
|
|
274
|
+
## analyze-coverage
|
|
275
|
+
|
|
276
|
+
Analyze mapping field coverage and identify gaps with detailed reports.
|
|
277
|
+
|
|
278
|
+
**Usage:**
|
|
279
|
+
```bash
|
|
280
|
+
npx fc-connect analyze-coverage [OPTIONS]
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
**Options:**
|
|
284
|
+
- `-m, --mapping <path>` - Mapping file or glob pattern (required)
|
|
285
|
+
- `-s, --schema <path>` - GraphQL schema JSON file (required)
|
|
286
|
+
- `--min-coverage <percent>` - Minimum total coverage % (fails if below)
|
|
287
|
+
- `--min-required <percent>` - Minimum required field coverage % (fails if below)
|
|
288
|
+
- `--show-missing` - Show detailed list of missing fields
|
|
289
|
+
- `--format <table|json|markdown>` - Output format (default: table)
|
|
290
|
+
- `-o, --output <path>` - Save report to file
|
|
291
|
+
- `-h, --help` - Show help message
|
|
292
|
+
|
|
293
|
+
**Examples:**
|
|
294
|
+
|
|
295
|
+
```bash
|
|
296
|
+
# Basic coverage report
|
|
297
|
+
npx fc-connect analyze-coverage \
|
|
298
|
+
--mapping ./mappings/createOrder.json \
|
|
299
|
+
--schema ./schema/fluent-schema.json
|
|
300
|
+
|
|
301
|
+
# With coverage thresholds (for CI/CD)
|
|
302
|
+
npx fc-connect analyze-coverage \
|
|
303
|
+
--mapping ./mappings/createOrder.json \
|
|
304
|
+
--schema ./schema/fluent-schema.json \
|
|
305
|
+
--min-coverage 80 \
|
|
306
|
+
--min-required 100
|
|
307
|
+
|
|
308
|
+
# Show missing fields
|
|
309
|
+
npx fc-connect analyze-coverage \
|
|
310
|
+
--mapping ./mappings/createOrder.json \
|
|
311
|
+
--schema ./schema/fluent-schema.json \
|
|
312
|
+
--show-missing
|
|
313
|
+
|
|
314
|
+
# JSON output for automation
|
|
315
|
+
npx fc-connect analyze-coverage \
|
|
316
|
+
--mapping ./mappings/*.json \
|
|
317
|
+
--schema ./schema/fluent-schema.json \
|
|
318
|
+
--format json \
|
|
319
|
+
--output coverage-report.json
|
|
320
|
+
|
|
321
|
+
# Markdown report for documentation
|
|
322
|
+
npx fc-connect analyze-coverage \
|
|
323
|
+
--mapping ./mappings/createOrder.json \
|
|
324
|
+
--schema ./schema/fluent-schema.json \
|
|
325
|
+
--format markdown \
|
|
326
|
+
--output ./docs/coverage.md
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
**Coverage Metrics:**
|
|
330
|
+
- **Required Coverage**: % of required fields that are mapped
|
|
331
|
+
- **Optional Coverage**: % of optional fields that are mapped
|
|
332
|
+
- **Total Coverage**: % of all fields (required + optional) that are mapped
|
|
333
|
+
|
|
334
|
+
**Example Output:**
|
|
335
|
+
```
|
|
336
|
+
╔═══════════════════════════════════════════════════════════════════════╗
|
|
337
|
+
║ Coverage Report: createOrder-mapping.json ║
|
|
338
|
+
╠═══════════════════════════════════════════════════════════════════════╣
|
|
339
|
+
║ Operation: createOrder ║
|
|
340
|
+
║ Direction: ingest ║
|
|
341
|
+
╠═══════════════════════════════════════════════════════════════════════╣
|
|
342
|
+
║ Required Fields: 10/10 (100%) ✅ ║
|
|
343
|
+
║ Optional Fields: 5/20 (25%) ║
|
|
344
|
+
║ Total Coverage: 15/30 (50%) ║
|
|
345
|
+
╚═══════════════════════════════════════════════════════════════════════╝
|
|
346
|
+
```
|
|
347
|
+
|
|
348
|
+
**Exit Codes:**
|
|
349
|
+
- `0` - Coverage meets thresholds
|
|
350
|
+
- `1` - Coverage below thresholds
|
|
351
|
+
- `2` - Invalid arguments or file errors
|
|
352
|
+
|
|
353
|
+
**CI/CD Integration:**
|
|
354
|
+
|
|
355
|
+
```yaml
|
|
356
|
+
# GitHub Actions - Enforce coverage thresholds
|
|
357
|
+
- name: Check mapping coverage
|
|
358
|
+
run: |
|
|
359
|
+
npx fc-connect analyze-coverage \
|
|
360
|
+
--mapping ./mappings/*.json \
|
|
361
|
+
--schema ./schema.json \
|
|
362
|
+
--min-coverage 80 \
|
|
363
|
+
--min-required 100
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
```bash
|
|
367
|
+
# Pre-commit hook
|
|
368
|
+
#!/bin/bash
|
|
369
|
+
npx fc-connect analyze-coverage \
|
|
370
|
+
--mapping ./mappings/*.json \
|
|
371
|
+
--schema ./schema.json \
|
|
372
|
+
--min-required 100 \
|
|
373
|
+
|| { echo "❌ Required fields not fully mapped"; exit 1; }
|
|
374
|
+
```
|
|
375
|
+
|
|
376
|
+
## CLI Workflow Example
|
|
377
|
+
|
|
378
|
+
Complete workflow for creating and validating mappings:
|
|
379
|
+
|
|
380
|
+
```bash
|
|
381
|
+
# 1. Introspect and cache the schema
|
|
382
|
+
npx fc-connect introspect-schema \
|
|
383
|
+
--endpoint https://api.fluentcommerce.com/graphql \
|
|
384
|
+
--output ./schema/fluent-schema.json
|
|
385
|
+
|
|
386
|
+
# 2. Generate mutation mapping template
|
|
387
|
+
npx fc-connect generate-mutation-mapping \
|
|
388
|
+
--file ./mutations/createOrder.graphql \
|
|
389
|
+
--schema ./schema/fluent-schema.json \
|
|
390
|
+
--output ./mappings/createOrder.json
|
|
391
|
+
|
|
392
|
+
# 3. Edit the mapping file (replace TODO placeholders)
|
|
393
|
+
# vim ./mappings/createOrder.json
|
|
394
|
+
|
|
395
|
+
# 4. Validate the mapping
|
|
396
|
+
npx fc-connect validate-schema \
|
|
397
|
+
--mapping ./mappings/createOrder.json \
|
|
398
|
+
--schema ./schema/fluent-schema.json
|
|
399
|
+
|
|
400
|
+
# 5. Check coverage
|
|
401
|
+
npx fc-connect analyze-coverage \
|
|
402
|
+
--mapping ./mappings/createOrder.json \
|
|
403
|
+
--schema ./schema/fluent-schema.json \
|
|
404
|
+
--show-missing \
|
|
405
|
+
--min-required 100
|
|
406
|
+
|
|
407
|
+
# 6. Generate coverage report for documentation
|
|
408
|
+
npx fc-connect analyze-coverage \
|
|
409
|
+
--mapping ./mappings/*.json \
|
|
410
|
+
--schema ./schema/fluent-schema.json \
|
|
411
|
+
--format markdown \
|
|
412
|
+
--output ./docs/mapping-coverage.md
|
|
413
|
+
```
|
|
414
|
+
|
|
415
|
+
## See Also
|
|
416
|
+
|
|
417
|
+
- [Module 05: Services](./api-reference-05-services.md#universal-mapper) - Using generated mappings
|
|
418
|
+
- [Getting Started Guide](../../../00-START-HERE/getting-started.md) - Basic setup
|
|
419
|
+
- [CLI Tools Documentation](../../../../bin/readme.md) - Complete CLI documentation
|
|
420
|
+
|
|
421
|
+
---
|
|
422
|
+
|
|
423
|
+
**[← Previous: Module 10 - Utilities](./api-reference-10-utilities.md)** | **[API Reference Home](../api-reference-readme.md)** | **[Next: Module 12 - Testing →](./api-reference-12-testing.md)**
|