Slack Next-gen Platform - Trigger Configurator

$ slack create? Select a template to build from:  Hello World  A simple workflow that sends a greeting  Scaffolded project  A solid foundational project that uses a Slack datastore> Blank project  A, well.. blank project  To see all available samples, visit github.com/slack-samples.

$ cd vibrant-orca-513$ slack run? Choose a workspace  seratch  T03E94MJU   App is not installed to this workspaceUpdating dev app install for workspace "Acme Corp"  Outgoing domains   No allowed outgoing domains are configured   If your function makes network requests, you will need to allow the outgoing domains   Learn more about upcoming changes to outgoing domains: https://api.slack.com/future/changelog  seratch of Acme CorpConnected, awaiting events

import { DefineWorkflow, Schema } from "deno-slack-sdk/mod.ts";export const workflow = DefineWorkflow({  callback_id: "main_event_workflow",  title: "Main event workflow",  input_parameters: {    properties: {      // The list of input properties needs to be consistent with      // the trigger operation code in `manage_triggers.ts`      userId: { type: Schema.slack.types.user_id },      channelId: { type: Schema.slack.types.channel_id },      messageTs: { type: Schema.types.string },      reaction: { type: Schema.types.string },    },    required: ["userId", "channelId", "reaction"],  },});// Send an ephemeral message when an expected reaction is addedworkflow.addStep(Schema.slack.functions.SendEphemeralMessage, {  user_id: workflow.inputs.userId,  channel_id: workflow.inputs.channelId,  message: `Thanks for adding :${workflow.inputs.reaction}:!`,});// This source file does not have its trigger definition!// The "reaction_added" event trigger will be created by// the "Configurator" workflow's custom function.

import { Manifest } from "deno-slack-sdk/mod.ts";// Add thisimport { workflow as MainWorkflow } from "./main_workflow.ts";export default Manifest({  name: "vibrant-orca-513",  description: "Configurator Demo",  icon: "assets/default_new_app_icon.png",  workflows: [MainWorkflow], // Add this  outgoingDomains: [],  botScopes: [    "commands",    "chat:write",    "chat:write.public",    // We're going to use "reaction_added" event trigger    "reactions:read",  ],});

import { SlackAPIClient } from "deno-slack-api/types.ts";// These need to be consistent with `main_workflow.ts`const triggerEventType = "slack#/events/reaction_added";const triggerName = "reaction_added event trigger";const triggerInputs = {  userId: { value: "{{data.user_id}}" },  channelId: { value: "{{data.channel_id}}" },  messageTs: { value: "{{data.message_ts}}" },  reaction: { value: "{{data.reaction}}" },};/** * Check if the target trigger already exists and then return the metadata if it exists. * @param client Slack API client * @param workflowCallbackId the target workflow's callback_id * @returns the existing trigger's metadata (can be undefined) */export async function findTriggerToUpdate(  client: SlackAPIClient,  workflowCallbackId: string,): Promise<Record<string, string> | undefined> {  // Fetch all the triggers that this app can access  const listResponse = await client.workflows.triggers.list({ is_owner: true });  // Find the target trigger in the list  // If the list contains duplicated items, this function may not work properly  if (listResponse && listResponse.triggers) {    for (const trigger of listResponse.triggers) {      if (        trigger.workflow.callback_id === workflowCallbackId &&        trigger.event_type === triggerEventType      ) {        return trigger;      }    }  }  // The target trigger does not exist yet  return undefined;}/** * Create or update the target trigger. The operation by this method is not atomic, meaning that duplicated triggers can be generated when the creation is requested simultaneously. Also, when updating the trigger, there is no validation of conflicts. * @param client Slack API client * @param workflowCallbackId the target workflow's callback_id * @param channelIds the list of channel IDs to enable the trigger * @param triggerId the existing trigger ID (only for updates) */export async function createOrUpdateTrigger(  client: SlackAPIClient,  workflowCallbackId: string,  channelIds: string[],  triggerId?: string,): Promise<void> {  // Since the Deno SDK type constraints require hard-coding the list of string items, there is no way to pass the method argument for it directly. Thus, we have to bypass the type check here.  // deno-lint-ignore no-explicit-any  const channel_ids = channelIds as any;  if (triggerId) {    // Update the existing trigger    const update = await client.workflows.triggers.update({      trigger_id: triggerId,      type: "event",      name: triggerName,      workflow: `#/workflows/${workflowCallbackId}`,      event: { event_type: triggerEventType, channel_ids },      inputs: triggerInputs,    });    if (update.error) {      const error = `Failed to update a trigger! - ${JSON.stringify(update)}`;      throw new Error(error);    }    console.log(`The trigger updated: ${JSON.stringify(update)}`);  } else {    // Create a new trigger    const creation = await client.workflows.triggers.create({      type: "event",      name: triggerName,      workflow: `#/workflows/${workflowCallbackId}`,      event: { event_type: triggerEventType, channel_ids },      inputs: triggerInputs,    });    if (creation.error) {      const error = `Failed to create a trigger! - ${JSON.stringify(creation)}`;      throw new Error(error);    }    console.log(`A new trigger created: ${JSON.stringify(creation)}`);  }}

import { SlackAPIClient } from "deno-slack-api/types.ts";/** * Join all the channels. * Even when the app's bot user has joined, the API does not return an error. * @param client * @param channelIds * @returns */export async function joinAllChannels(  client: SlackAPIClient,  channelIds: string[],): Promise<string | undefined> {  const futures = channelIds.map((c) => _joinChannel(client, c));  const results = (await Promise.all(futures)).filter((r) => r !== undefined);  if (results.length > 0) {    throw new Error(results[0]);  }  return undefined;}async function _joinChannel(  client: SlackAPIClient,  channelId: string,): Promise<string | undefined> {  const response = await client.conversations.join({ channel: channelId });  if (response.error) {    const error = `Failed to join <#${channelId}> due to ${response.error}`;    console.log(error);    return error;  }}

import { DefineFunction, Schema, SlackFunction } from "deno-slack-sdk/mod.ts";import {  createOrUpdateTrigger,  findTriggerToUpdate,} from "./manage_triggers.ts";import { joinAllChannels } from "./join_channels.ts";import { FunctionSourceFile } from "https://deno.land/x/[email protected]/mod.ts";export const def = DefineFunction({  callback_id: "configure",  title: "Configure a trigger",  source_file: FunctionSourceFile(import.meta.url),  input_parameters: {    properties: {      workflowCallbackId: { type: Schema.types.string },      channelIds: {        type: Schema.types.array,        items: { type: Schema.slack.types.channel_id },      },    },    required: ["workflowCallbackId", "channelIds"],  },  output_parameters: { properties: {}, required: [] },});export default SlackFunction(def, async ({ inputs, client }) => {  try {    await createOrUpdateTrigger(      client,      inputs.workflowCallbackId,      inputs.channelIds,      (await findTriggerToUpdate(client, inputs.workflowCallbackId))?.id,    );  } catch (e) {    const error = `Failed to create/update a trigger due to ${e}.`;    return { error };  }  // If you don't need to invite your app's bot user to the channels,  // you can safely remove the following part:  const failure = await joinAllChannels(client, inputs.channelIds);  if (failure) {    const error = `Failed to join channels due to ${failure}.`;    return { error };  }  return { outputs: {} };});

import { DefineWorkflow, Schema } from "deno-slack-sdk/mod.ts";export const workflow = DefineWorkflow({  callback_id: "webhook_configurator",  title: "Webhook Configurator",  input_parameters: {    properties: {      channel_ids: {        type: Schema.types.array,        items: { type: Schema.slack.types.channel_id },      },    },    required: ["channel_ids"],  },});import { def as Configure } from "./configure.ts";import { workflow as MainWorkflow } from "./main_workflow.ts";workflow.addStep(Configure, {  // The callback_id here must be the one for "Main" workflow!  workflowCallbackId: MainWorkflow.definition.callback_id,  channelIds: workflow.inputs.channel_ids,});// Trigger to invoke the "Configurator" workflowimport { Trigger } from "deno-slack-api/types.ts";const trigger: Trigger<typeof workflow.definition> = {  type: "webhook",  name: "Webhook Configurator Trigger",  // The callback_id here must be the one for "Configurator" workflow!  workflow: `#/workflows/${workflow.definition.callback_id}`,  inputs: { "channel_ids": { "value": "{{data.channel_ids}}" } },};export default trigger;

import { Manifest } from "deno-slack-sdk/mod.ts";import { workflow as MainWorkflow } from "./main_workflow.ts";// Add thisimport { workflow as ConfiguratorWorkflow } from "./webhook_configurator.ts";export default Manifest({  name: "vibrant-orca-513",  description: "Configurator Demo",  icon: "assets/default_new_app_icon.png",  workflows: [MainWorkflow, ConfiguratorWorkflow], // Add this  outgoingDomains: [],  botScopes: [    "commands",    "chat:write",    "chat:write.public",    // We're going to use "reaction_added" event trigger    "reactions:read",    // Required for `configure.ts`    "triggers:read",    "triggers:write",    "channels:join",  ],});

$ slack triggers create --trigger-def ./webhook_configurator.ts? Choose an app  seratch (dev)  T03E94MJU   vibrant-orca-513 (dev) A04FRL4323G Trigger created   Trigger ID:   Ft04FY7H1AM9   Trigger Type: webhook   Trigger Name: Webhook Configurator Trigger   Webhook URL:  https://hooks.slack.com/triggers/T03E94***/***/***

$ curl -XPOST \  https://hooks.slack.com/triggers/T03E94***/***/*** \  -d'{"channel_ids": ["C03E94MKS"]}'{"ok":true}%

$ slack run? Choose a workspace  seratch  T03E94MJU   vibrant-orca-513 A04FRL4323GUpdating dev app install for workspace "Acme Corp"  Outgoing domains   No allowed outgoing domains are configured   If your function makes network requests, you will need to allow the outgoing domains   Learn more about upcoming changes to outgoing domains: https://api.slack.com/future/changelog  seratch of Acme CorpConnected, awaiting events2022-12-20 14:14:29 [info] [Fn04GN1S5CP2] (Trace=Tr04FRNYD1QW) Function execution started for workflow function 'Webhook Configurator'2022-12-20 14:14:29 [info] [Wf04FY7BP8M9] (Trace=Tr04FHQLH3K9) Execution started for workflow 'Webhook Configurator'2022-12-20 14:14:30 [info] [Wf04FY7BP8M9] (Trace=Tr04FHQLH3K9) Executing workflow step 1 of 12022-12-20 14:14:30 [info] [Fn04FVCA06N9] (Trace=Tr04FHQLH3K9) Function execution started for app function 'Configure a trigger'A new trigger created: {"ok":true,"trigger":{ ... }}2022-12-20 14:14:32 [info] [Fn04FVCA06N9] (Trace=Tr04FHQLH3K9) Function execution completed for function 'Configure a trigger'2022-12-20 14:14:32 [info] [Wf04FY7BP8M9] (Trace=Tr04FHQLH3K9) Execution completed for workflow step 'Configure a trigger'2022-12-20 14:14:33 [info] [Fn04GN1S5CP2] (Trace=Tr04FRNYD1QW) Function execution completed for function 'Webhook Configurator'2022-12-20 14:14:33 [info] [Wf04FY7BP8M9] (Trace=Tr04FHQLH3K9) Execution completed for workflow 'Webhook Configurator'

import { DefineFunction, Schema, SlackFunction } from "deno-slack-sdk/mod.ts";import {  createOrUpdateTrigger,  findTriggerToUpdate,} from "./manage_triggers.ts";import { joinAllChannels } from "./join_channels.ts";import { FunctionSourceFile } from "https://deno.land/x/[email protected]/mod.ts";export const def = DefineFunction({  callback_id: "configure_interactive",  title: "Configure a trigger using a modal",  source_file: FunctionSourceFile(import.meta.url),  input_parameters: {    properties: {      interactivity: { type: Schema.slack.types.interactivity },      workflowCallbackId: { type: Schema.types.string },    },    required: ["interactivity", "workflowCallbackId"],  },  output_parameters: { properties: {}, required: [] },});export default SlackFunction(def, async ({ inputs, client }) => {  const trigger = await findTriggerToUpdate(client, inputs.workflowCallbackId);  const channelIds = trigger?.channel_ids ?? [];  const response = await client.views.open({    interactivity_pointer: inputs.interactivity.interactivity_pointer,    view: {      "type": "modal",      "callback_id": "configure-workflow",      "title": { "type": "plain_text", "text": "My App" },      "submit": { "type": "plain_text", "text": "Confirm" },      "close": { "type": "plain_text", "text": "Close" },      "blocks": [        {          "type": "input",          "block_id": "channels",          "element": {            "type": "multi_channels_select",            "initial_channels": channelIds,            "action_id": "action",          },          "label": {            "type": "plain_text",            "text": "Channels to enable the main workflow",          },        },      ],    },  });  if (response.error) {    const error =      `Failed to open a modal in the configurator workflow. Contact the app maintainers with the following information - (error: ${response.error})`;    return { error };  }  return {    // To continue the interaction, you must return completed: false    completed: false,  };})  .addViewSubmissionHandler(    ["configure-workflow"],    async ({ inputs, client, view }) => {      const channelIds = view.state.values.channels.action.selected_channels;      try {        await createOrUpdateTrigger(          client,          inputs.workflowCallbackId,          channelIds,          (await findTriggerToUpdate(client, inputs.workflowCallbackId))?.id,        );      } catch (e) {        const error = `Failed to create/update a trigger due to ${e}.`;        return { error };      }      // If you don't need to invite your app's bot user to the channels,      // you can safely remove the following part:      const failure = await joinAllChannels(client, channelIds);      if (failure) {        const error = `Failed to join channels due to ${failure}.`;        return { error };      }      // Display the completion page      return {        response_action: "update",        view: {          "type": "modal",          "callback_id": "completion",          "title": { "type": "plain_text", "text": "My App" },          "close": { "type": "plain_text", "text": "Close" },          "blocks": [            {              "type": "section",              "text": {                "type": "mrkdwn",                "text":                  "*You're all set!*

The main workflow is now available for the channels :white_check_mark:",              },            },          ],        },      };    },  );

import { DefineWorkflow, Schema } from "deno-slack-sdk/mod.ts";export const workflow = DefineWorkflow({  callback_id: "modal-configurator",  title: "Modal Configurator",  input_parameters: {    properties: { interactivity: { type: Schema.slack.types.interactivity } },    required: ["interactivity"],  },});import { def as ConfigureWithModal } from "./configure_interactive.ts";import { workflow as MainWorkflow } from "./main_workflow.ts";workflow.addStep(ConfigureWithModal, {  interactivity: workflow.inputs.interactivity,  // The callback_id here must be the one for "Main" workflow!  workflowCallbackId: MainWorkflow.definition.callback_id,});// Trigger to invoke the "Configurator" workflowimport { Trigger } from "deno-slack-api/types.ts";const trigger: Trigger<typeof workflow.definition> = {  type: "shortcut",  name: "Modal Configurator Trigger",  // The callback_id here must be the one for "Configurator" workflow!  workflow: `#/workflows/${workflow.definition.callback_id}`,  inputs: { interactivity: { value: "{{data.interactivity}}" } },};export default trigger;

import { Manifest } from "deno-slack-sdk/mod.ts";import { workflow as MainWorkflow } from "./main_workflow.ts";// Add thisimport { workflow as ConfiguratorWorkflow } from "./webhook_configurator.ts";import { workflow as ModalConfiguratorWorkflow } from "./modal_configurator.ts";export default Manifest({  name: "vibrant-orca-513",  description: "Configurator Demo",  icon: "assets/default_new_app_icon.png",  workflows: [MainWorkflow, ConfiguratorWorkflow, ModalConfiguratorWorkflow], // Add this  outgoingDomains: [],  botScopes: [    "commands",    "chat:write",    "chat:write.public",    // We're going to use "reaction_added" event trigger    "reactions:read",    // Required for `configure.ts`    "triggers:read",    "triggers:write",    "channels:join",  ],});