Needs Puma Managers

    trekin
    TypeScript icon, indicating that this package has built-in type declarations

    0.7.0 • Public • Published

    trekin

    A npm library that connects Trello to kintone.

    npm version CI codecov FOSSA Status

    Installation

    Use the package manager npm to install trekin.

    npm i trekin

    Sample

    Please read this repository.

    https://github.com/korosuke613/trekin-sample

    Supported Trello events

    • createCard
    • updateCard
    • copyCard
    • createList
    • updateList
    • createLabel
    • updateLabel
    • addLabelToCard
    • removeLabelFromCard
    • addMemberToCard
    • removeMemberFromCard
    • commentCard

    Usage

    Instantiation Trekin

    import { Trekin } from "trekin";
     
    const trekin = new Trekin(
      {
        baseUrl: "https://example.cybozu.com/", // Your domain
        defaultKintoneUserCode: "john",  // Your kintone user code
        cards: {
          id: "1", // Your kintone app ID for Card
          token: "...", // Your kintone app API token for Card
        },
        labels: {
          id: "2", // Your kintone app ID for Label
          token: "...", // Your kintone app API token for Label
        },
        lists: {
          id: "3", // Your kintone app ID for List
          token: "...", // Your kintone app API token for List
        },
        members: {
          id: "4", // Your kintone app ID for Member
          token: "...", // Your kintone app API token for Member
        },
      },
      {
        apiKey: "...", // Your Trello user API key
        apiToken: "...", // Your Trello user API token
      }
    );

    Storing Trello events in Objects

    Turn Trello's webhook response into an object.

    const trelloWebhookAction: Action = JSON.parse(
      await fs.readFileSync("trelloEvent.json", "utf8")
    ).body.action;

    Post Trello events to kintone

    const result = await trekin.operation(trelloWebhookAction);
    console.info("Operation\n" + JSON.stringify(result));

    Post kintone events to Trello

    const postResult = await trekin.postOperation(trelloWebhookAction);
    console.info("Post operation\n" + JSON.stringify(postResult));

    Setting of trekin

    Exclude Card

    Trekin support Card exclusion settings. If all the conditions enclosed in braces are met, the event is skipped.

    trekin.guardian.setting = {
      excludes: [
        {
          charactersOrLess: 12,
          match: "\\d{2}\\/\\d{2}\\/\\d{4}",
        },
        {
          match: "Test!!"
        }
      ],
    };
    • Card name is ⬆️27/09/2020, skip.
    • Card name is Prepare for the event on 27/09/2020., not skip.
    • Card name is This is createCard Test!!, skip.
    Exclude option list
    option type description
    charactersOrLess number If the card name is less than or equal to the set value, exclude it.
    match regexp If the card name matches to the set regular expression, exclude it.

    License

    MIT

    FOSSA Status

    Install

    npm i trekin

    DownloadsWeekly Downloads

    10

    Version

    0.7.0

    License

    MIT

    Unpacked Size

    435 kB

    Total Files

    56

    Last publish

    Collaborators

    • korosuke613