dc-integration-tester

This tool is useful for testing integrations with dc-integration-middleware and the credentials for them. Integrations are located at ./integrations.json or $HOME/.amplience/integrations.json and should contain a JSON object with keys for each vendor configuration.

{
    "commercetools": {
        "vendor": "commercetools",
        "codec_params": {
            "project": "<ct project key>",
            "client_id": "<ct client id>",
            "client_secret": "<ct client secret>",
            "auth_url": "<ct auth url",
            "api_url": "<ct api url>",
            "scope": "<list of scopes>"
        }
    },

    "sfcc": {
        "vendor": "sfcc",
        "codec_params": {
            "api_url": "<sfcc api url>",
            "auth_url": "<sfcc auth url>",
            "site_id": "<sfcc site id>",
            "client_id": "<sfcc client id>",
            "client_secret": "<sfcc site secret>"
        }
    },
    "bigcommerce": {
        "vendor": "bigcommerce",
        "codec_params": {
            "api_url": "<bigcommerce api url>",
            "api_token": "<bigcommerce api token>",
            "store_hash": "<bigcommerce store hash>"
        }
    },
    "rest": {
        "vendor": "rest",
        "codec_params": {
            "productURL": "https://demostore-catalog.s3.us-east-2.amazonaws.com/products.json",
            "categoryURL": "https://demostore-catalog.s3.us-east-2.amazonaws.com/categories.json",
            "customerGroupURL": "https://demostore-catalog.s3.us-east-2.amazonaws.com/customerGroups.json",
            "translationsURL": "https://demostore-catalog.s3.us-east-2.amazonaws.com/translations.json"
        }
    },
    "shopify": {
        "vendor": "shopify",
        "codec_params": {
            "access_token": "<storefront access token>",
            "admin_access_token": "<admin access token>",
            "version": "<api version, eg. 2023-01>",
            "site_id": "<shopify site id>"
        }
    }
}

Dependency versions

This project has been tested with the following versions:

• Node version 18.x
• NPM version 9.x

Use

• nvm use (or nvm use 18 on windows)
• npm i
• npm run build
• npm link
• dc-integration-tester <arguments>
  • Just run dc-integration-tester to get a list of commands. Use --help to get help with any command.

Commands

dc-integration-tester <command>

Commands:
  dc-integration-tester get-category-tree   Gets the category tree from the
  <vendor>                                  given vendor
  dc-integration-tester get-category        Gets a category from the given
  <vendor> <slug>                           vendor
  dc-integration-tester                     Gets customer groups from the given
  get-customer-groups <vendor>              vendor
  dc-integration-tester get-product         Gets a product from the given vendor
  <vendor> <id>
  dc-integration-tester get-products        Gets a products from the given
  <vendor>                                  vendor

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]

Development

When using this tool to aid in the development of demostore integrations, do the following:

• nvm use (or nvm use 18 on windows)
• npm i
• npm i .../dc-integration-middleware
  • ...or whatever the local path is to the dc-integration-middleware.
  • Whenever you make any changes to the demostore integrations, make sure you npm run build on that project.
• npm run dev -- <arguments>
  • Run a command without building and linking.

License

This software is licensed under the Apache License, Version 2.0,

Copyright 2023 Amplience

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.