JSPM

serverless-commercetools-plugin

1.0.0
    • ESM via JSPM
    • ES Module Entrypoint
    • Export Map
    • Keywords
    • License
    • Repository URL
    • TypeScript Types
    • README
    • Created
    • Published
    • Downloads 15
    • Score
      100M100P100Q52592F
    • License MIT

    Serverless framework plugin that registers the deployed function as a commercetools API Extension or attaches it to a Subscription.

    Package Exports

    • serverless-commercetools-plugin

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (serverless-commercetools-plugin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Serverless commercetools Plugin

    Serverless framework plugin that registers the deployed function as a commercetools API Extension or attaches it to a Subscription.

    Configuration and Deploy for AWS

    1. At the bottom of your function's serverless.yaml place: plugins: - serverless-commercetools-plugin In your serverless function create a folder called .serverless_plugins. Place the serverless-commercetools-plugin folder into .serverless_plugins with dependencies installed.

    2. In your serverless.yaml under the service, directly below region, add environment vars for your commercetools client.

      Example:

           region: us-east-2
                     environment:
                          CTP_PROJECT_KEY: "your_key"
                          CTP_CLIENT_SECRET: "your_secret"
                          CTP_CLIENT_ID: "your_clientid"
                          CTP_AUTH_URL: "your_authurl"
                          CTP_API_URL: "your_apiUrl"
                          CTP_SCOPES: "your_scopes"
           
                          
    3. In your severlerless.yaml add environment vars for the deploy type ("extension" or "subscription") and your body configuration for the Subscription or Extension.

    Example 1. Extensions:

                               CTP_DEPLOY_TYPE: "extension"
                               CTP_POST_BODY: '{
                                    "destination": {
                                    "type": "AWSLambda",
                                   "arn": "arn:aws:lambda:us-east-1:12345678:function:awsmainlambda-dev-hello",
                                   "accessKey": "your_key",
                                   "accessSecret": "your_secret"
                                   },
                                   "triggers": [{
                                   "resourceTypeId": "cart",
                                   "actions": ["Create", "Update"]
                                   }]
                               }'
                             
                            
                            

    Example 2. Subscriptions:

                           CTP_DEPLOY_TYPE: "subscription"
                           CTP_POST_BODY: '{
                                  "destination": {
                                    "type": "SQS",
                                    "queueUrl": "<url_to_your_queue>",
                                 "accessKey": "<your_key>",
                                 "accessSecret": "<your_secret>",
                                 "region": "<your_region>"
                                  },
                                 "messages": [
                                 {
                                     "resourceTypeId": "order"
                                 }
                                 ]
                            }'
                         
                            
    1. Run serverless deploy.

    Development

    In your serverless function create a folder called .serverless_plugins. Place your plugin folder there for development.