How to build a Commerce Layer Slackbot with Node.js and Slack API.

import * as dotenv from "dotenv";
dotenv.config();

import CommerceLayer from "@commercelayer/sdk";
import { getIntegrationToken } from "@commercelayer/js-auth";

export const initConfig = async () => {
  const BASE_ENDPOINT = `https://${process.env.CL_ORGANIZATION_SLUG}.commercelayer.io`;
  const CLIENT_ID = process.env.CL_CLIENT_ID;
  const CLIENT_ID_CHECKOUT = process.env.CL_CLIENT_ID_CHECKOUT;
  const CLIENT_SECRET = process.env.CL_CLIENT_SECRET;
  const organizationSlug = process.env.CL_ORGANIZATION_SLUG;
  const organizationMode = process.env.CL_ORGANIZATION_MODE;

  const { accessToken: token } = await getIntegrationToken({
    endpoint: BASE_ENDPOINT,
    clientId: CLIENT_ID,
    clientSecret: CLIENT_SECRET
  });

  const cl = CommerceLayer({
    organization: organizationSlug,
    accessToken: token
  });

  return {
    cl,
    BASE_ENDPOINT,
    CLIENT_ID,
    CLIENT_ID_CHECKOUT,
    CLIENT_SECRET,
    organizationSlug,
    organizationMode
  };
};

import * as dotenv from "dotenv";
dotenv.config();

import { getSalesChannelToken } from "@commercelayer/js-auth";

export const getCheckoutToken = async (config, marketNumber: number) => {
	const { BASE_ENDPOINT, CLIENT_ID, CLIENT_SECRET } = config;
  const auth = await getSalesChannelToken({
    endpoint: BASE_ENDPOINT,
    clientId: CLIENT_ID_CHECKOUT,
    scope: `market:${marketNumber}`
  });
  return auth.accessToken;
};

import { getCheckoutToken } from "../utils/getToken";
import { generateDate } from "../utils/parseDate.js";

const getOrderById = async (id: string, config) => {
	const { cl, organizationSlug, organizationMode } = config;
  try {
    const orders = await cl.orders.retrieve(id, {
      include: ["customer", "market", "shipments", "shipping_address", "billing_address", "payment_method"]
    });

    const checkoutAccessToken = await getCheckoutToken(config, orders.market.number);

    return { orders, organizationSlug, organizationMode, checkoutAccessToken };
  } catch (error) {
    return { error };
  }
};

const getLastOrder = async (status: string, config) => {
	const { cl, organizationSlug, organizationMode } = config;
  try {
    const orders = (
      await cl.orders.list({
        include: ["customer", "market", "shipments", "shipping_address", "billing_address", "payment_method"],
        filters: { status_eq: `${status}` },
        sort: status === "placed" ? { placed_at: "desc" } : { approved_at: "desc" }
      })
    ).first();

    return { orders, organizationSlug, organizationMode };
  } catch (error) {
    return { error };
  }
};

const getTodaysOrder = async (currency: string, config) => {
	const { cl, organizationSlug } = config;
  const currencyName = currency.toUpperCase();

  const allOrders = await cl.orders.list({
    filters: {
      status_eq: "placed",
      placed_at_gteq: `${generateDate("today")}}`,
      placed_at_lt: `${generateDate("next")}}`
    }
  });
  const allOrdersCount = allOrders.meta.recordCount;

  const allOrdersByMarket = await cl.orders.list({
    filters: {
      currency_code_eq: `${currencyName}`,
      status_eq: "placed",
      placed_at_gteq: `${generateDate("today")}}`,
      placed_at_lt: `${generateDate("next")}}`
    }
  });
  const allOrdersByMarketCount = allOrdersByMarket.meta.recordCount;

  const revenue = allOrdersByMarket.reduce((acc, order) => {
    return acc + order.total_amount_cents;
  }, 0);

  let revenueCount;
  allOrdersByMarketCount !== 0
    ? (revenueCount = (revenue / 100).toLocaleString(
        `${allOrdersByMarket[0].language_code}-${allOrdersByMarket[0].country_code}`,
        {
          style: "currency",
          currency: `${allOrdersByMarket[0].currency_code}`
        }
      ))
    : (revenueCount = 0);

  return {
    allOrdersCount,
    allOrdersByMarketCount,
    revenueCount,
    currencyName,
    organizationSlug
  };
};

export { getOrderById, getLastOrder, getTodaysOrder };

import { initConfig } from "./src/utils/config";

app.command("/cl", async ({ command, client, ack, say }) => {
  await ack();

	const config = await initConfig();

  if (command.text.startsWith("order ")) {
    const resourceType = getOrderById(command.text.replace("order ", ""), config);
    getOrderResource(resourceType, command, client, say);
  } else if (command.text === "orders:p last" || command.text === "orders:last") {
    const resourceType = getLastOrder("placed", config);
    getOrderResource(resourceType, command, client, say);
  } else if (command.text === "orders:a last") {
    const resourceType = getLastOrder("approved", config);
    getOrderResource(resourceType, command, client, say);
  }

  if (command.text.startsWith("return ")) {
    const resourceType = getReturnById(command.text.replace("return ", ""), config);
    getReturnResource(resourceType, command, client, say);
  } else if (command.text === "returns:r last" || command.text === "returns:last") {
    const resourceType = getLastReturn("requested", config);
    getReturnResource(resourceType, command, client, say);
  } else if (command.text === "returns:a last") {
    const resourceType = getLastReturn("approved", config);
    getReturnResource(resourceType, command, client, say);
  }

  if (command.text.startsWith("orders:today ")) {
    const resourceType = getTodaysOrder(command.text.replace("orders:today ", ""));
    countOrders(resourceType, command, client, say);
  }

  if (command.text.startsWith("returns:today")) {
    const resourceType = getTodaysReturn();
    countReturns(resourceType, command, client, say);
  }
});

const getOrderResource = async (resourceType, userInput, client, say) => {
  // Make a request to fetch the user information of the user that triggered the command.
  // We will use their profile image and display name in the response message.
  const triggerUser = await client.users.info({
    user: userInput.user_id
  });
  const resource = await resourceType;

  // If the functions in getOrders.ts returns undefined or an empty object, return an error message.
  // The custom error handler can be found here on GitHub here:
  // https://github.com/commercelayer/examples/tree/main/solutions/commercelayer-slackbot/src/utils/customError.ts
  if (!resource.orders) {
    await say({
      blocks: [
        {
          type: "section",
          text: {
            type: "mrkdwn",
            text: `> :warning: Command ${"`"}${userInput.command} ${
              userInput.text
            }${"`"} failed with error: ${"```"}${JSON.stringify(customError("Order"), null, 2)}${"```"}`
          }
        }
      ],
      // Add a fallback plain text for notifications and accessibility.
      text: customError("Order")
    });
    // If the functions in getOrders.ts returns some data object, return an interactive message.
  } else {
    await say({
      blocks: [
        {
          type: "section",
          text: {
            type: "mrkdwn",
            text: `:shopping_trolley: Order ${"`"}${resource.orders.id}${"`"} from the *${
              resource.orders.market.name
            }* market has a total amount of *${resource.orders.formatted_subtotal_amount}* and was ${
              resource.orders.placed_at !== null ? "placed" : "created"
            } on <!date^${formatTimestamp(
              resource.orders.placed_at !== null ? resource.orders.placed_at : resource.orders.created_at
            )}^{date_long} at {time}|${
              resource.orders.placed_at !== null ? resource.orders.placed_at : resource.orders.created_at
            }>. Here's a quick summary of the resource:`
          }
        },
        {
          type: "divider"
        },
        {
          type: "section",
          fields: [
            {
              type: "mrkdwn",
              text: `*Customer email:*\n${resource.orders.customer !== null ? resource.orders.customer.email : "null"}`
            },
            {
              type: "mrkdwn",
              text: `*Customer ID:*\n<https://dashboard.commercelayer.io/${
                resource.organizationMode === "live" ? "live" : "test"
              }/${resource.organizationSlug}/resources/customers/${
                resource.orders.customer !== null ? resource.orders.customer.id : "null"
              }|${resource.orders.customer !== null ? resource.orders.customer.id : "null"}>`
            }
          ]
        },
        {
          type: "section",
          fields: [
            {
              type: "mrkdwn",
              text: `*Order number:*\n${"`"}${resource.orders.number}${"`"}`
            },
            {
              type: "mrkdwn",
              text: `*Order status:*\n${"`"}${resource.orders.status}${"`"}`
            }
          ]
        },
        {
          type: "section",
          fields: [
            {
              type: "mrkdwn",
              text: `*Payment status:*\n${"`"}${resource.orders.payment_status}${"`"}`
            },
            {
              type: "mrkdwn",
              text: `*Fulfillment status:*\n${"`"}${resource.orders.fulfillment_status}${"`"}`
            }
          ]
        },
        {
          type: "section",
          fields: [
            {
              type: "mrkdwn",
              text: `*Shipping address:*\n${
                resource.orders.shipping_address !== null
                  ? resource.orders.shipping_address.full_name + ", " + resource.orders.shipping_address.full_address
                  : "null"
              }.`
            },
            {
              type: "mrkdwn",
              text: `*Billing address:*\n${
                resource.orders.billing_address !== null
                  ? resource.orders.billing_address.full_name + ", " + resource.orders.billing_address.full_address
                  : "null"
              }.`
            }
          ]
        },
        {
          type: "section",
          fields: [
            {
              type: "mrkdwn",
              text: `*Payment method:*\n${
                resource.orders.payment_method !== null ? resource.orders.payment_method.name : "null"
              }`
            },
            {
              type: "mrkdwn",
              text: `*Shipment number(s):*\n${
                resource.orders.shipments.length > 0
                  ? resource.orders.shipments.map((shipment) => {
                      if (resource.orders.shipments.length > 1) {
                        return `<https://dashboard.commercelayer.io/${
                          resource.organizationMode === "live" ? "live" : "test"
                        }/${resource.organizationSlug}/resources/shipments/${shipment.id}|${shipment.number}>, `;
                      } else {
                        return `<https://dashboard.commercelayer.io/${
                          resource.organizationMode === "live" ? "live" : "test"
                        }/${resource.organizationSlug}/resources/shipments/${shipment.id}|${shipment.number}>`;
                      }
                    })
                  : "null"
              }`
            }
          ]
        },
        {
          type: "actions",
          elements: [
            resource.orders.status === "pending"
              ? {
                  type: "button",
                  text: {
                    type: "plain_text",
                    text: "Checkout Order",
                    emoji: true
                  },
                  style: "primary",
                  value: "checkout_order",
                  url: `https://${resource.organizationSlug}.checkout.commercelayer.app/${resource.orders.id}?accessToken=${resource.checkoutAccessToken}`,
                  action_id: "check_order"
                }
              : {
                  type: "button",
                  text: {
                    type: "plain_text",
                    text: "View Order",
                    emoji: true
                  },
                  style: "primary",
                  value: "view_order",
                  url: `https://dashboard.commercelayer.io/${resource.organizationMode === "live" ? "live" : "test"}/${
                    resource.organizationSlug
                  }/resources/orders/${resource.orders.id}`,
                  action_id: "check_order"
                },
            {
              type: "button",
              text: {
                type: "plain_text",
                text: "View Customer",
                emoji: true
              },
              value: "view_customer",
              url: `https://dashboard.commercelayer.io/${resource.organizationMode === "live" ? "live" : "test"}/${
                resource.organizationSlug
              }/resources/customers/${resource.orders.customer !== null ? resource.orders.customer.id : "null"}`,
              action_id: "view_customer"
            }
          ]
        },
        {
          type: "divider"
        },
        {
          type: "context",
          elements: [
            {
              type: "image",
              image_url: `${triggerUser.user.profile.image_72}`,
              alt_text: `${triggerUser.user.profile.display_name || triggerUser.user.profile.real_name}'s avatar`
            },
            {
              type: "mrkdwn",
              text: `${
                triggerUser.user.profile.display_name || triggerUser.user.profile.real_name
              } has triggered this request.`
            }
          ]
        }
      ],
      // Add a fallback plain text for notifications and accessibility.
      text: `:shopping_trolley: Order ${"`"}${resource.orders.id}${"`"} from the *${
        resource.orders.market.name
      }* market has a total amount of *${resource.orders.formatted_subtotal_amount}* and was ${
        resource.orders.placed_at !== null ? "placed" : "created"
      } on <!date^${formatTimestamp(
        resource.orders.placed_at !== null ? resource.orders.placed_at : resource.orders.created_at
      )}^*{date_long}* at *{time}*|${
        resource.orders.placed_at !== null ? resource.orders.placed_at : resource.orders.created_at
      }>.`
    });
  }
};

{
    "token": "l8V3x7zxuHhHELLOXSrlpif3",
    "team_id": "T34NRBRSLK9",
    "context_team_id": "T34NRBRSLK9",
    "context_enterprise_id": null,
    "api_app_id": "A04NTNAWORL",
    "event": {
        "bot_id": "B04PXV400EU",
        "type": "message",
        "text": ":shopping_trolley: Order `wJZYhAmvBO` from the *USA* market has a total amount of *$102.00* and was created on <!date^1676918681^*{date_long}* at *{time}*|2023-02-20T18:44:41.309Z>.",
        "user": "U04NTNKLPPEK",
        "ts": "1679328956.227089",
        "app_id": "A04NTNAWORL",
        "blocks": [
            {
                "type": "section",
                "block_id": "U/UMb",
                "text": {
                    "type": "mrkdwn",
                    "text": ":shopping_trolley: Order `wJZYhAmvBO` from the *USA* market has a total amount of *$102.00* and was created on <!date^1676918681^{date_long} at {time}|2023-02-20T18:44:41.309Z>. Here's a quick summary of the resource:",
                    "verbatim": false
                }
            },
            {
                "type": "divider",
                "block_id": "GTpp"
            },
            {
                "type": "section",
                "block_id": "O6XY",
                "fields": [
                    {
                        "type": "mrkdwn",
                        "text": "*Customer email:*\n<mailto:aeafury@gmail.com|aeafury@gmail.com>",
                        "verbatim": false
                    },
                    {
                        "type": "mrkdwn",
                        "text": "*Customer ID:*\n<https://dashboard.commercelayer.io/test/cake-store/resources/customers/kNXNhbDNmB|kNXNhbDNmB>",
                        "verbatim": false
                    }
                ]
            },
            {
                "type": "section",
                "block_id": "gQX",
                "fields": [
                    {
                        "type": "mrkdwn",
                        "text": "*Order number:*\n`34085857`",
                        "verbatim": false
                    },
                    {
                        "type": "mrkdwn",
                        "text": "*Order status:*\n`pending`",
                        "verbatim": false
                    }
                ]
            },
            {
                "type": "section",
                "block_id": "lB6",
                "fields": [
                    {
                        "type": "mrkdwn",
                        "text": "*Payment status:*\n`unpaid`",
                        "verbatim": false
                    },
                    {
                        "type": "mrkdwn",
                        "text": "*Fulfillment status:*\n`unfulfilled`",
                        "verbatim": false
                    }
                ]
            },
            {
                "type": "section",
                "block_id": "n3Si",
                "fields": [
                    {
                        "type": "mrkdwn",
                        "text": "*Shipping address:*\nErdaulet Adikhanov , Zhetisay, Home Home, 160500 Turkistan Please select a region, state or province. (KZ) 87059829273.",
                        "verbatim": false
                    },
                    {
                        "type": "mrkdwn",
                        "text": "*Billing address:*\nErdaulet Adikhanov , Zhetisay, Home Home, 160500 Turkistan Please select a region, state or province. (KZ) 87059829273.",
                        "verbatim": false
                    }
                ]
            },
            {
                "type": "section",
                "block_id": "YnfYw",
                "fields": [
                    {
                        "type": "mrkdwn",
                        "text": "*Payment method:*\nnull",
                        "verbatim": false
                    },
                    {
                        "type": "mrkdwn",
                        "text": "*Shipment number(s):*\n<https://dashboard.commercelayer.io/test/cake-store/resources/shipments/YkEzCELVRJ|34085857/S/001>",
                        "verbatim": false
                    }
                ]
            },
            {
                "type": "actions",
                "block_id": "=mnr1",
                "elements": [
                    {
                        "type": "button",
                        "action_id": "check_order",
                        "text": {
                            "type": "plain_text",
                            "text": "Checkout Order",
                            "emoji": true
                        },
                        "style": "primary",
                        "value": "checkout_order",
                        "url": "https://cake-store.checkout.commercelayer.app/wJZYhAmvBO?accessToken=eyJhbGciOiJIUzUxMiJ9.eyJvcmdhbml6YXRpb24iOnsiaWQiOiJFbnBWT0ZyS3Z5Iiwic2x1ZyI6ImNha2Utc3RvcmUiLCJlbnRlcnByaXNlIjpmYWxzZX0sImFwcGxpY2F0aW9uIjp7ImlkIjoibHBKcW5pSlhkTSIsImtpbmQiOiJzYWxlc19jaGFubmVsIiwicHVibGljIjp0cnVlfSwidGVzdCI6dHJ1ZSwiZXhwIjoxNzEwODY0OTU1LCJtYXJrZXQiOnsiaWQiOlsiWWxxeEdoS3JRZyJdLCJwcmljZV9saXN0X2lkIjoid2xacnZDWXJLbCIsInN0b2NrX2xvY2F0aW9uX2lkcyI6WyJ6bkJqeHVsTFZuIiwiWmtZcVh1ZFZkayJdLCJnZW9jb2Rlcl9pZCI6bnVsbCwiYWxsb3dzX2V4dGVybmFsX3ByaWNlcyI6ZmFsc2V9LCJyYW5kIjowLjY1MzEyNjIwMzIyNTY5MjV9.7iU1rCXijtBQ8LCuluPYCXKKYjXUIGz_FEfbgOSyAJL5f9bILtclWg3uoUuE9tI5VKgj_teFiKBSZOVyMEFchA"
                    },
                    {
                        "type": "button",
                        "action_id": "view_customer",
                        "text": {
                            "type": "plain_text",
                            "text": "View Customer",
                            "emoji": true
                        },
                        "value": "view_customer",
                        "url": "https://dashboard.commercelayer.io/test/cake-store/resources/customers/kNXNhbDNmB"
                    }
                ]
            },
            {
                "type": "divider",
                "block_id": "GnGf"
            },
            {
                "type": "context",
                "block_id": "DXTjR",
                "elements": [
                    {
                        "type": "image",
                        "image_url": "https://secure.gravatar.com/avatar/551d7dcacd90143bd0cbe29ac68c212c.jpg?s=72&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0024-72.png",
                        "alt_text": "bolaji-bot's avatar"
                    },
                    {
                        "type": "mrkdwn",
                        "text": "bolaji-bot has triggered this request.",
                        "verbatim": false
                    }
                ]
            }
        ],
        "team": "T04NTHRSKK9",
        "bot_profile": {
            "id": "B04PXV323EU",
            "deleted": false,
            "name": "Commerce Layer Bot",
            "updated": 1678213218,
            "app_id": "A04NTNAPX2B",
            "icons": {
                "image_36": "https://avatars.slack-edge.com/2023-02-12/4790294597874_713e6192e0862a34e839_36.png",
                "image_48": "https://avatars.slack-edge.com/2023-02-12/4790294597874_713e6192e0862a34e839_48.png",
                "image_72": "https://avatars.slack-edge.com/2023-02-12/4790294597874_713e6192e0862a34e839_72.png"
            },
            "team_id": "T34NRBRSLK9"
        },
        "channel": "C04P5617VFC",
        "event_ts": "1679328956.227089",
        "channel_type": "channel"
    },
    "type": "event_callback",
    "event_id": "Ev04UCFFK6KZ",
    "event_time": 1679328956,
    "authorizations": [
        {
            "enterprise_id": null,
            "team_id": "T34NRBRSLK9",
            "user_id": "U04NTNKLPPEK",
            "is_bot": true,
            "is_enterprise_install": false
        }
    ],
    "is_ext_shared_channel": false,
    "event_context": "4-eyJldCI6Im1lc3NhZ2UiLCJ0aWQiOiJUMDROVEhSU0tLOSIsImFpZCI6IkEwNE5UTkFQWDJCIiwiY2lkIjoiQzA0UDg0MTdWRkMifQ"
}