https://github.com/slackapi/deno-slack-hub

Connectors used to build coded workflows for Run on Slack apps using Deno
https://github.com/slackapi/deno-slack-hub

deno slack

Last synced: 10 days ago
JSON representation

Connectors used to build coded workflows for Run on Slack apps using Deno

• Host: GitHub
• URL: https://github.com/slackapi/deno-slack-hub
• Owner: slackapi
• License: mit
• Created: 2023-05-04T19:44:49.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-15T18:06:10.000Z (7 months ago)
• Last Synced: 2024-04-24T11:39:10.313Z (7 months ago)
• Topics: deno, slack
• Language: TypeScript
• Homepage: https://deno.land/x/deno_slack_hub
• Size: 163 KB
• Stars: 8
• Watchers: 9
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        


  Deno Slack Hub

  




You want to use other peoples code to do your work?


We definitely do! The hub enables its users to use

[Slack Connectors](https://api.slack.com/automation/connectors) in TypeScript,

offloading the cost of code maintenance and OAuth management to other

developers. Interact with APIs from `Google`, `Salesforce`, `GitHub`, `Giphy`

and more with a minimal amount of code and offload your credential management to

Slack.

## Requirements

- A recent version of

  [`deno`](https://deno.com/manual/getting_started/installation).

- The Slack CLI ([install steps](https://api.slack.com/automation/cli/install))

## Versioning

Releases for this repository follow the [SemVer](https://semver.org/) versioning

scheme. The HUB's contract is determined by the top-level exports from

`src/mod.ts` and `src/types.ts`. Exports not included in these files are deemed

internal and any modifications will not be treated as breaking changes. As such,

internal exports should be treated as unstable and used at your own risk.

## Usage

### Getting started

Follow our

[quick start guide for modular Slack apps](https://api.slack.com/automation/quickstart)

### Samples

Take a look at some our

[sample & template](https://api.slack.com/automation/samples) projects to get

started with the latest version of the

[deno-slack-sdk](https://github.com/slackapi/deno-slack-sdk)

### Consumption

Import the

[latest version of `deno-slack-hub`](https://deno.land/x/deno_slack_hub) in your

next gen Deno project, we recommend doing this through the `import_map.json`.

```json

{

  "imports": {

    "deno-slack-sdk/": "https://deno.land/x/[email protected]/",

    "deno-slack-api/": "https://deno.land/x/[email protected]/",

    "deno-slack-hub/": "https://deno.land/x/[email protected]/"

  }

}

```

### Using connectors as a step in a coded workflow

Using connectors as a step in a coded workflow

```ts

import { DefineWorkflow, Schema } from "deno-slack-sdk/mod.ts";

import { Connectors } from "deno-slack-hub/mod.ts";

const GifWorkflow = DefineWorkflow({

  callback_id: "post_random_gif",

  title: "Workflow to post a random gif in a channel",

  description: "A workflow that post a random gif in the channel it is invoked",

  input_parameters: {

    properties: {

      channel_id: {

        type: Schema.slack.types.channel_id,

      },

    },

    required: ["channel_id"],

  },

});

const getRandomGifStep = GifWorkflow.addStep(

  Connectors.Giphy.functions.GetRandomGif,

  {

    rating: "g",

  },

);

GifWorkflow.addStep(Schema.slack.functions.SendMessage, {

  channel_id: GifWorkflow.inputs.channel_id,

  message: getRandomGifStep.outputs.gif_title_url,

});

export default GifWorkflow;

```

## Contributions

We welcome contributions from everyone! Please check out our

[Contributor's Guide](https://github.com/slackapi/deno-slack-hub/blob/main/.github/CONTRIBUTING.md)

for how to contribute in a helpful and collaborative way.