Convert an existing integration to a Connector

deployAs:
  - name: service_app_name
    applicationType: service
    endpoint: /service
    scripts:
      postDeploy: npm run connector:post-deploy
      preUndeploy: npm run connector:pre-undeploy
    configuration:
      standardConfiguration:
        - key: CTP_PROJECT_KEY
          description: Project key of the commercetools Composable Commerce Project
          required: true
          default: 'default-key'
      securedConfiguration:
        - key: CTP_CLIENT_ID
          description: client_id of an API Client for the commercetools Composable Commerce Project
          required: true
  - name: job_app_name
    applicationType: job
    endpoint: /job
    properties:
      schedule: '*/5 * * * *'
    configuration:
      standardConfiguration:
        - key: CTP_PROJECT_KEY
          description: Project key of the commercetools Composable Commerce Project
          required: true
      securedConfiguration:
        - key: CTP_CLIENT_ID
          description: client_id of an API Client for the commercetools Composable Commerce Project
          required: true

myconnector/
├── service_app_name/
│   ├── server.js
│   └── package.json
├── job_app_name/
│   ├── server.js
│   └── package.json
└── connect.yaml

import express, { Request, Response } from 'express';
import bodyParser from 'body-parser';

const app = express();
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: true }));

app.post('/service', async (req: Request, res: Response) => {
  const action = req.body;
  console.info('New action received', action);

  // handle business logic
  const additionalActions = [];
  // build additional resource update action

  res.status(200).json({ actions: additionalActions });
});

import express, { Request, Response } from 'express';
import bodyParser from 'body-parser';

const app = express();
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: true }));

app.post('/event', async (req: Request, res: Response) => {
  const event = req.body;
  console.info('New event received', event);

  // handle business logic
  // ex: notify user product back in stock

  res.status(200).send();
});

import express, { Request, Response } from 'express';
import bodyParser from 'body-parser';

const app = express();

app.post('/job', async (req: Request, res: Response) => {
  const event = req.body;
  console.info('New event received', event);

  // handle business logic
  // ex: build report, send email

  res.status(200).send();
});

"scripts": {
    "gcp-build": "tsc",
    "start": "node build/index.js"
}

# connect.yaml
# ...
applicationType: service
scripts:
  postDeploy: node post-deploy.js
  preUndeploy: node pre-undeploy.js
# ...

// post-deploy.js
async function run() {
  try {
    const EXTENSION_KEY = 'myconnector-extension-key';
    const serviceUrl = process.env.CONNECT_SERVICE_URL;
    // ...
    const result = await apiRoot
      .extensions()
      .post({
        body: {
          key: EXTENSION_KEY,
          destination: {
            type: 'HTTP',
            url: serviceUrl,
          },
          triggers: [
            {
              resourceTypeId: 'cart',
              actions: ['Update'],
            },
          ],
        },
      })
      .execute();
  } catch (error) {
    process.stderr.write(`Post-deploy failed: ${error.message}\n`);
    process.exitCode = 1;
  }
}

run();

// pre-undeploy.js
async function run() {
  try {
    const EXTENSION_KEY = 'myconnector-extension-key';
    const serviceUrl = process.env.CONNECT_SERVICE_URL;
    // ...
    const result = await apiRoot
      .extensions()
      .delete({
        body: {
          key: EXTENSION_KEY,
        },
      })
      .execute();
  } catch (error) {
    process.stderr.write(`Post-deploy failed: ${error.message}\n`);
    process.exitCode = 1;
  }
}

run();

# connect.yaml
# ...
applicationType: event
scripts:
  postDeploy: node post-deploy.js
  preUndeploy: node pre-undeploy.js
# ...

// post-deploy.js
async function run() {
  try {
    const SUBSCRIPTION_KEY = 'myconnector-subscription-key';
    const topicName = process.env.CONNECT_GCP_TOPIC_NAME;
    const projectId = process.env.CONNECT_GCP_PROJECT_ID;
    // ...
    const result = await apiRoot
      .subscriptions()
      .post({
        body: {
          key: SUBSCRIPTION_KEY,
          destination: {
            type: 'GoogleCloudPubSub',
            topic: topicName,
            projectId,
          },
          messages: [
            {
              resourceTypeId: 'customer',
              types: ['CustomerCreated'],
            },
          ],
        },
      })
      .execute();
  } catch (error) {
    process.stderr.write(`Post-deploy failed: ${error.message}\n`);
    process.exitCode = 1;
  }
}

run();

// pre-undeploy.js
async function run() {
  try {
    const SUBSCRIPTION_KEY = 'myconnector-subscription-key';
    // ...
    const result = await apiRoot
      .subscriptions()
      .delete({ body: { key: SUBSCRIPTION_KEY } })
      .execute();
  } catch (error) {
    process.stderr.write(`Post-deploy failed: ${error.message}\n`);
    process.exitCode = 1;
  }
}

run();

// isInteger.js
const isInteger = (value) => !isNaN(parseInt(value, 10));

export { isInteger };

// __tests__/isInteger.spec.js
import { isInteger } from './isInteger';

describe('isInteger function', () => {
  test('it should check if value is an integer number', () => {
    expect(isInteger(-1)).toEqual(true);
    expect(isInteger(0)).toEqual(true);
    expect(isInteger(1).toEqual(true));
    expect(isInteger(1.5).toEqual(false));
  });
});

npm test

PASS  __tests__/isInteger.spec.js
  isInteger function
    ✓ it should check if value is an integer number (2ms)

Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        0.764s, estimated 1s