diff --git a/README.md b/README.md index 52fb95ba031..c525a9630db 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -![](apps/webapp/public/images/coming-soon-banner.png) +### The Trigger.dev Private beta is now open. Sign up for access [here](https://bcymafitv0e.typeform.com/tddsignup#source=GitHubReadme). +  - ### We are now accepting users 😊! Request early access [here](https://bcymafitv0e.typeform.com/tddsignup#source=GitHubReadme). +![Hero](https://raw.githubusercontent.com/triggerdotdev/trigger.dev/eebe37109e33beae6390ee19029fce8a5934c84b/apps/webapp/public/images/logo-banner.png) -  --- @@ -12,7 +12,9 @@ ![Logo](https://trigger.dev/_next/static/media/triggerdotdev-logo.9226e5d0.png?imwidth=256) -[![Twitter Follow](https://img.shields.io/twitter/follow/triggerdotdev)](https://twitter.com/intent/follow?screen_name=triggerdotdev) +[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/triggerdotdev.svg?style=social&label=Follow%20%40trigger.dev)](https://twitter.com/triggerdotdev) + + # ⚙️ Automate complex workflows with code diff --git a/apps/docs/examples/examples.mdx b/apps/docs/examples/examples.mdx index 4c380405fa6..bf39b257665 100644 --- a/apps/docs/examples/examples.mdx +++ b/apps/docs/examples/examples.mdx @@ -1,17 +1,26 @@ --- title: "Example workflows" -sidebarTitle: "Example workflows" -description: "Example workflows." +sidebarTitle: "Overview" +description: "Example workflows to use in your projects." --- -# Example workflows + + Trigger.dev is in private beta. We are now inviting users from our waitlist + [here.](https://bcymafitv0e.typeform.com/tddsignup?typeform-source=trigger.dev#source=Docs) + + +Not sure what to build? Take a look through our examples for inspiration. +You can use these workflows in your product by following the instructions on each page. - - - + + When a GitHub issue is created or modified, post a message to Slack. + + + Create a new product in my Shopify store. + + + Post to Slack when a GitHub issue is created or modified. + + diff --git a/apps/docs/functions/logging.mdx b/apps/docs/functions/logging.mdx index 7123cd047ce..f868fb9bea4 100644 --- a/apps/docs/functions/logging.mdx +++ b/apps/docs/functions/logging.mdx @@ -4,4 +4,38 @@ sidebarTitle: "Logging" description: "There are 4 different types of logs you can add as workflow steps." --- -## Coming soon +If you'd like to add additional logging to your workflow run, you can use our built-in logging utility + +## Usage + +```ts +import { Trigger } from "@trigger.dev/sdk"; + +new Trigger({ + id: "my-trigger", + on: scheduleEvent({ rateOf: { minutes: 5 } }), + run: async (event, ctx) => { + await ctx.logger.info("It's been 5 minutes since the last run!"); + }, +}).listen(); +``` + +This will log the message to your workflow run page in the Trigger dashboard + +There are 4 different types of logs you can add as workflow steps: + +```ts +await ctx.logger.info("It's been 5 minutes since the last run!"); +await ctx.logger.debug("This is a debug log"); +await ctx.logger.warn("This is a warning"); +await ctx.logger.error("This is an error"); +``` + +You can also include a second argument to the logger to add additional metadata to the log: + +```ts +await ctx.logger.info("It's been 5 minutes since the last run!", { + foo: "bar", + baz: 123, +}); +``` diff --git a/apps/docs/functions/loops-conditionals-etc.mdx b/apps/docs/functions/loops-conditionals-etc.mdx index 93378b49e6f..7015718b966 100644 --- a/apps/docs/functions/loops-conditionals-etc.mdx +++ b/apps/docs/functions/loops-conditionals-etc.mdx @@ -4,4 +4,47 @@ sidebarTitle: "Loops, Conditionals…" description: "Write any type of code." --- -## Coming soon +Currently, we don't have anything special for loops or conditionals. You can just write plain-old TypeScript code and it will Just Work™. + +## Loops + +When you perform an action (sendEvent, delays, etc.) inside of a loop, make sure to create unique keys for each action to make sure that your workflows are [Resumable](/guides/resumability): + +```ts +for (let i = 0; i < 10; i++) { + await ctx.waitFor(`Wait ${i}`, { seconds: 30 }); + + await slack.postMessage(`⭐️ New Star ${i}`, { + channelName: "github-stars", + text: `@${starredBy} just starred ${repoName}!`, + }); +} +``` + +## Parallel Execution + +You can run actions in parallel using `Promise.all`, like so: + +```ts +await Promise.all( + messages.map((message) => + slack.postMessage(message.id, { + channelName: "github-stars", + text: message.text, + }) + ) +); +``` + +## Conditionals + +You can use `if` statements to conditionally execute code, just like normal code: + +```ts +if (ctx.event.payload.action === "opened") { + await slack.postMessage("New Issue", { + channelName: "github-issues", + text: `@${ctx.event.payload.sender.login} just opened an issue!`, + }); +} +``` diff --git a/apps/docs/get-help.mdx b/apps/docs/get-help.mdx new file mode 100644 index 00000000000..ad81fb2d93f --- /dev/null +++ b/apps/docs/get-help.mdx @@ -0,0 +1,26 @@ +--- +title: "Get in touch with us!" +sidebarTitle: "Get help" +description: "Contact us if you have any questions, or would like help with any issues." +--- + +We are active in the community and will respond to all messages. + +Please email us at help@trigger.dev or choose one of the options below: + + + + The place to meet other users, the team and to get product updates. + + + A call with someone from our support team. We are happy to help. + + diff --git a/apps/docs/getting-started.mdx b/apps/docs/getting-started.mdx index 58d3da4fff2..42d05273fcd 100644 --- a/apps/docs/getting-started.mdx +++ b/apps/docs/getting-started.mdx @@ -4,6 +4,11 @@ sidebarTitle: "Quick start" description: "Get your first workflow running in just a few minutes" --- + + Trigger.dev is in private beta. We are now inviting users from our waitlist + [here.](https://bcymafitv0e.typeform.com/tddsignup?typeform-source=trigger.dev#source=Docs) + + Trigger.dev workflows are written in your codebase and run in your existing infrastructure. This means: - They are version controlled with the rest of your code. @@ -182,6 +187,15 @@ When you run your server and this code executes, it will trigger the workflow. Y ## Next steps + + Meet other users, get help and product updates. We will respond to all + messages and will help with any issues. + + There are many things we didn't cover here, including Webhook and Scheduled triggers. Below are a some more features to explore: ### Triggers @@ -192,13 +206,13 @@ Triggers are what cause your workflows to run. Easily subscribe to the APIs you're using - + Trigger your workflows on a repeating schedule - + More details on custom events - + On received email, HTTP endpoint and AWS Event Bridge @@ -213,11 +227,14 @@ Triggers are what cause your workflows to run. > We are making it easy to use lots of APIs by adding integrations. - + + Call any API from your workflow + + Add delays to your workflows. They're resilient so it doesn't matter if your server goes down. - + Send an event, to trigger a custom event workflow diff --git a/apps/docs/guides/event-driven.mdx b/apps/docs/guides/event-driven.mdx new file mode 100644 index 00000000000..4392d4a818e --- /dev/null +++ b/apps/docs/guides/event-driven.mdx @@ -0,0 +1,9 @@ +--- +title: "Event Driven Architecture" +sidebarTitle: "Event Driven" +description: "How to build an event driven architecture using Trigger.dev" +--- + +## Intro + +Coming soon... diff --git a/apps/docs/guides/resumability.mdx b/apps/docs/guides/resumability.mdx index 6e689ae026f..8ad09b38675 100644 --- a/apps/docs/guides/resumability.mdx +++ b/apps/docs/guides/resumability.mdx @@ -1,7 +1,72 @@ --- title: "Resumability" sidebarTitle: "Keys and Resumability" -description: "Keys and Resumability" +description: "Understand how keys work to ensure resumability of long-running workflows in Trigger.dev" --- -## Coming soon +## Intro + +In this article, we'll cover how Trigger.dev handles resumability of long-running workflows. We'll also cover how to use keys to ensure that your workflows are resumable. + +## What is resumability? + +Resumability is the ability of a workflow run to continue from where it left off after a failure or interruption. For example, if a workflow run is interrupted due to a network failure, it should be able to resume from where it left off when the network is back up. + +We accomplish this by storing the state of the workflow run in a database, and when a workflow run is resumed we will call the `Trigger.run` function again. + +We use step "keys" to determine which steps have already been executed. If a step has already been executed, we will skip it and move on to the next step. + +## How to use keys + +Like we mentioned above, we use step keys to determine which steps have already been executed. They are defined by you inside your `Trigger.run` function, for example when you call `slack.postMessage`: + +```ts +await slack.postMessage("⭐️ New Star", { + channelName: "github-stars", + text: `@${starredBy} just starred ${repoName}!`, +}); +``` + +In this example, the key is the string `"⭐️ New Star"`. This means that if the workflow is interrupted and then resumed, the `slack.postMessage` step will be skipped because it has already been executed. + +If you make multiple calls to `slack.postMessage`, you should use different keys for each call. For example: + +```ts +await slack.postMessage("⭐️ New Star", { + channelName: "github-stars", + text: `@${starredBy} just starred ${repoName}!`, +}); + +await slack.postMessage("🚨 Critical Issue", { + channelName: "critical-issues", + text: `@${assignee} just opened a critical issue in ${repoName}!`, +}); +``` + +If you are calling a step multiple times with the same key, it will only be executed once. For example, if you call `slack.postMessage` with the key `"⭐️ New Star"` twice, it will only be executed once. + +## How to use keys with loops + +If you are using a loop, you should use the loop index as the key. For example: + +```ts +for (let i = 0; i < 10; i++) { + await ctx.waitFor(`Wait ${i}`, { seconds: 30 }); + + await slack.postMessage(`⭐️ New Star ${i}`, { + channelName: "github-stars", + text: `@${starredBy} just starred ${repoName}!`, + }); +} +``` + +## When to use keys + +The following functions in Trigger.dev require a `key` parameter: + +- Integration actions (e.g. `slack.postMessage`) +- [delays](/functions/delays) +- [sendEvent](/functions/send-event) +- [fetch](/functions/fetch) + +[Logging](/functions/logging) does not require a key, as we are currently using the log message as the key. diff --git a/apps/docs/guides/zod.mdx b/apps/docs/guides/zod.mdx index 8803c2f59d1..646d3681402 100644 --- a/apps/docs/guides/zod.mdx +++ b/apps/docs/guides/zod.mdx @@ -1,7 +1,306 @@ --- -title: "Zod" +title: "Zod Guide" sidebarTitle: "Zod" description: "TypeScript-first schema validation with static type inference" --- -## Coming soon +## Intro + +Zod is a fantastic utility package by [@colinhacks](https://twitter.com/colinhacks) that allows for defining runtime schema validation and type-safety. + +We use it [extensively](https://github.com/search?q=repo%3Atriggerdotdev%2Ftrigger.dev+%22zod%22%3B&type=code) internally at Trigger.dev to ensure we never trigger your workflows with invalid data (and more). + +But there are a few places where we ask you to provide us with a Zod schema, for example when defining a [Custom Event Trigger](/triggers/custom-events): + +```ts +import { Trigger, customEvent } from "@trigger.dev/sdk"; +import { slack } from "@trigger.dev/integrations"; +import { z } from "zod"; + +//this workflow will run when a "user.created" event is sent +new Trigger({ + id: "zod", + name: "Zod custom event", + //this is the custom event subscription + on: customEvent({ + name: "user.created", + schema: z.object({ + name: z.string(), + email: z.string(), + paidPlan: z.boolean(), + }), + }), + //this function is run when the custom event is received + run: async (event, ctx) => { + console.log(event); // Has name, email, paidPlan + }, +}).listen(); +``` + +So it will help to know a little about Zod and how to use it. We definitely recommend the well written [Zod README](https://github.com/colinhacks/zod#readme) but we've included a short primer below. + + + Wherever we require you to pass in a Zod schema, you can always start with + `z.any()` which accepts `any` type and then add more strict validations later. + + +## Basic Usage + +There are three main steps to using Zod: + +1. Define a schema + +```ts +import { z } from "zod"; + +const mySchema = z.object({ + name: z.string(), + email: z.string(), + paidPlan: z.boolean(), +}); +``` + +2. Infer TypeScript types from the schema + +```ts +type MySchema = z.infer; +``` + +3. Validate data against the schema + +```ts +const data: unknown = { + name: "Eric", + email: "eric@trigger.dev", + paidPlan: true, +}; + +const result = mySchema.parse(data); +``` + +When using Zod with Trigger.dev, you'll only really need to do the first step, and by passing it to us (through the `schema` property of the `customEvent` function), we'll do the second and third steps for you. + +## Defining Schemas + +### Primitives + +Zod schemas are a way to define the shape of an object. They can be as simple as a single type, or as complex as a nested object. + +```ts +// Primitives +z.string(); +z.number(); +z.boolean(); +z.date(); +z.undefined(); +z.null(); +``` + +Any schema can be marked as optional, which means the schema can be `undefined` or `null`: + +```ts +z.string().optional(); +``` + +Schemas can also be marked optional by providing a default value: + +```ts +const optionalString = z.string().default("default value"); + +const value = optionalString.parse(undefined); // value === "default value" +``` + +If you need to allow a value to be `null`, you can use `nullable()`: + +```ts +const nullableString = z.string().nullable(); + +const value = nullableString.parse(null); +``` + +You can also use Zod to coerce primites into other types. For example, you can coerce a string into a number: + +```ts +const numberString = z.coerce.number(); + +const value = numberString.parse("123"); // value === 123 +``` + +The following primitives are supported: + +```ts +z.coerce.string(); +z.coerce.number(); +z.coerce.boolean(); +z.coerce.bigint(); +z.coerce.date(); +``` + +Coercing dates are especially useful when you are receiving a `string` from an API and want to convert it to a JavaScript `Date` object: + +```ts +const date = z.coerce.date(); + +const value = date.parse("2021-01-01T00:00:00.000Z"); // value === Date object +``` + +### Objects + +Object schemas are the most common type of schema. They allow you to define the shape of an object, and the types of each property. + +```ts +const mySchema = z.object({ + name: z.string(), + email: z.string(), + paidPlan: z.boolean(), +}); +``` + +All properties are required by default, although you can make them all optional using `partial()`: + +```ts +const mySchema = z + .object({ + name: z.string(), + email: z.string(), + paidPlan: z.boolean(), + }) + .partial(); +``` + +You can also make individual properties optional: + +```ts +const mySchema = z.object({ + name: z.string(), + email: z.string(), + paidPlan: z.boolean().optional(), +}); +``` + +By default an object schema will strip out any extra properties that are not defined in the schema. You can disable this behavior using `passthrough()`: + +```ts +const mySchema = z.object({ + name: z.string(), +}); + +mySchema.parse({ name: "Eric", email: "eric@trigger.dev" }); // { name: "Eric" } +mySchema.passthrough().parse({ name: "Eric", email: "eric@trigger.dev" }); // { name: "Eric", email: "eric@trigger.dev" } +``` + +Or you can use `strict()` to make the schema throw an error if there are any extra properties: + +```ts +const mySchema = z + .object({ + name: z.string(), + }) + .strict(); + +mySchema.parse({ name: "Eric", email: "eric@trigger.dev" }); // throws error +``` + +Zod includes a few useful object schema utilities to help with reusing schemas, `extends()` and `merge()`: + +```ts +const baseSchema = z.object({ + name: z.string(), +}); + +const extendedSchema = baseSchema.extend({ + email: z.string(), +}); + +const mergedSchema = baseSchema.merge( + z.object({ + email: z.string(), + }) +); +``` + +You can also use `pick()` and `omit()` to create a new schema that only includes or excludes certain properties: + +```ts +const mySchema = z.object({ + name: z.string(), + email: z.string(), + paidPlan: z.boolean(), +}); + +const pickedSchema = mySchema.pick({ name: true, email: true }); +const omittedSchema = mySchema.omit({ paidPlan: true }); +``` + +### Arrays + +You can specify the schema of an array using `z.array()`: + +```ts +z.array(z.string()); // string[] +z.array(z.number()); // number[] +z.array(z.object({ name: z.string() })); // Array<{ name: string }> +``` + +You can also specify the type of array that has a fixed number of elements using `z.tuple()`: + +```ts +z.tuple([z.string(), z.number(), z.boolean()]); // [string, number, boolean] +``` + +### Unions + +You can specify a union of schemas using `z.union()`: + +```ts +z.union([z.string(), z.number(), z.boolean()]); // string | number | boolean +``` + +Discriminating unions are also supported, and especially useful when paired with type narrowing: + +```ts +const mySchema = z.discriminatingUnion("type", [ + z.object({ + type: z.literal("a"), + data: z.string(), + }), + z.object({ + type: z.literal("b"), + data: z.number(), + }), +]); + +const value = mySchema.parse({ type: "a", data: "hello" }); + +if (type.a) { + // value is { type: "a", data: string } +} else if (type.b) { + // value is { type: "b", data: number } +} +``` + +### Records + +You can specify a record of schemas using `z.record()`, useful for when you have a map of values but don't care about the keys: + +```ts +z.record(z.string()); // Record +z.record(z.number()); // Record +``` + +### JSON type + +If you want to accept any valid JSON value, you can use the following schema: + +```ts +const literalSchema = z.union([z.string(), z.number(), z.boolean(), z.null()]); +type Literal = z.infer; +type Json = Literal | { [key: string]: Json } | Json[]; +const jsonSchema: z.ZodType = z.lazy(() => + z.union([literalSchema, z.array(jsonSchema), z.record(jsonSchema)]) +); + +jsonSchema.parse(data); +``` + +Hat tip to [ggoodman](https://github.com/ggoodman) for this one. diff --git a/apps/docs/images/api-keys.png b/apps/docs/images/api-keys.png index 800b2e2885b..6090e768f24 100644 Binary files a/apps/docs/images/api-keys.png and b/apps/docs/images/api-keys.png differ diff --git a/apps/docs/images/docs-background.png b/apps/docs/images/docs-background.png new file mode 100644 index 00000000000..495c0e24907 Binary files /dev/null and b/apps/docs/images/docs-background.png differ diff --git a/apps/docs/images/favicon.png b/apps/docs/images/favicon.png index f612987cf0e..7540b1ea4d4 100644 Binary files a/apps/docs/images/favicon.png and b/apps/docs/images/favicon.png differ diff --git a/apps/docs/images/log-all.png b/apps/docs/images/log-all.png new file mode 100644 index 00000000000..295da552530 Binary files /dev/null and b/apps/docs/images/log-all.png differ diff --git a/apps/docs/images/log-info.png b/apps/docs/images/log-info.png new file mode 100644 index 00000000000..457f766fe9a Binary files /dev/null and b/apps/docs/images/log-info.png differ diff --git a/apps/docs/images/run-failed.png b/apps/docs/images/run-failed.png index 2790d35bea4..0ae981fd299 100644 Binary files a/apps/docs/images/run-failed.png and b/apps/docs/images/run-failed.png differ diff --git a/apps/docs/images/run-succeeded.png b/apps/docs/images/run-succeeded.png index e0c508473df..bddbaec63a1 100644 Binary files a/apps/docs/images/run-succeeded.png and b/apps/docs/images/run-succeeded.png differ diff --git a/apps/docs/images/run-test.png b/apps/docs/images/run-test.png index c080da4ceb3..080efd186a5 100644 Binary files a/apps/docs/images/run-test.png and b/apps/docs/images/run-test.png differ diff --git a/apps/docs/images/secure-string.png b/apps/docs/images/secure-string.png index b610c0539ec..a17414a5dad 100644 Binary files a/apps/docs/images/secure-string.png and b/apps/docs/images/secure-string.png differ diff --git a/apps/docs/images/workflow-demo.gif b/apps/docs/images/workflow-demo.gif new file mode 100644 index 00000000000..aa2108b372d Binary files /dev/null and b/apps/docs/images/workflow-demo.gif differ diff --git a/apps/docs/images/workflow.png b/apps/docs/images/workflow.png index c58a5b7a82c..d12eba024a2 100644 Binary files a/apps/docs/images/workflow.png and b/apps/docs/images/workflow.png differ diff --git a/apps/docs/integrations/apis/github/events/issue-comments.mdx b/apps/docs/integrations/apis/github/events/issue-comments.mdx new file mode 100644 index 00000000000..47c44effe7b --- /dev/null +++ b/apps/docs/integrations/apis/github/events/issue-comments.mdx @@ -0,0 +1,376 @@ +--- +title: "Issue Comment Event" +sidebarTitle: "Issue Comments" +description: "Trigger a workflow whenever an issue_comment action is performed in a GitHub repository." +--- + +## Usage + +```ts +import { github } from "@trigger.dev/integrations"; + +new Trigger({ + id: "demo", + on: github.events.issueCommentEvent({ + repo: "triggerdotdev/trigger.dev", + }), + run: async (event, ctx) => {}, +}).listen(); +``` + +## Params + + + The full path to the repository, including the organization + + +## Event + + + The issue_comment action, which can be either created, deleted, or edited. + + + + The comment object. + + + + The issue object. + + + + A repository on GitHub. + + + + The GitHub user object who performed the action. + + + + The organization object the repository belongs to. + + +## Example Workflows + + + +```typescript Notify Slack on new Issue comment +new Trigger({ + id: "github-to-slack", + name: "Notify Slack on new Issue comment", + on: github.events.issueCommentEvent({ + repo: "triggerdotdev/trigger.dev", + }), + run: async (event, ctx) => { + if (event.action === "created") { + await slack.postMessage("New Comment", { + channelName: "github-issues", + text: `New comment on issue ${event.issue.title} by ${event.sender.login}: ${event.comment.html_url}`, + }); + } + }, +}).listen(); +``` + + + +## Example Event payload + +```json +{ + "issue": { + "id": 1548436712, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/1", + "body": "Changed the body text once", + "user": { + "id": 10635986, + "url": "https://api.github.com/users/matt-aitken", + "type": "User", + "login": "matt-aitken", + "node_id": "MDQ6VXNlcjEwNjM1OTg2", + "html_url": "https://github.com/matt-aitken", + "gists_url": "https://api.github.com/users/matt-aitken/gists{/gist_id}", + "repos_url": "https://api.github.com/users/matt-aitken/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/10635986?v=4", + "events_url": "https://api.github.com/users/matt-aitken/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/matt-aitken/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/matt-aitken/followers", + "following_url": "https://api.github.com/users/matt-aitken/following{/other_user}", + "organizations_url": "https://api.github.com/users/matt-aitken/orgs", + "subscriptions_url": "https://api.github.com/users/matt-aitken/subscriptions", + "received_events_url": "https://api.github.com/users/matt-aitken/received_events" + }, + "state": "open", + "title": "Changed test issue title", + "labels": [ + { + "id": 5003355458, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/labels/documentation", + "name": "documentation", + "color": "0075ca", + "default": true, + "node_id": "LA_kwDOIxVdCc8AAAABKjklQg", + "description": "Improvements or additions to documentation" + }, + { + "id": 5003355474, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/labels/enhancement", + "name": "enhancement", + "color": "a2eeef", + "default": true, + "node_id": "LA_kwDOIxVdCc8AAAABKjklUg", + "description": "New feature or request" + } + ], + "locked": false, + "number": 1, + "node_id": "I_kwDOIxVdCc5cS0To", + "assignee": null, + "comments": 6, + "html_url": "https://github.com/triggerdotdev/trigger.dev-examples/issues/1", + "assignees": [], + "closed_at": null, + "milestone": { + "id": 8941544, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/milestones/1", + "state": "open", + "title": "Test milestone", + "due_on": "2023-01-20T08:00:00Z", + "number": 1, + "creator": { + "id": 10635986, + "url": "https://api.github.com/users/matt-aitken", + "type": "User", + "login": "matt-aitken", + "node_id": "MDQ6VXNlcjEwNjM1OTg2", + "html_url": "https://github.com/matt-aitken", + "gists_url": "https://api.github.com/users/matt-aitken/gists{/gist_id}", + "repos_url": "https://api.github.com/users/matt-aitken/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/10635986?v=4", + "events_url": "https://api.github.com/users/matt-aitken/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/matt-aitken/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/matt-aitken/followers", + "following_url": "https://api.github.com/users/matt-aitken/following{/other_user}", + "organizations_url": "https://api.github.com/users/matt-aitken/orgs", + "subscriptions_url": "https://api.github.com/users/matt-aitken/subscriptions", + "received_events_url": "https://api.github.com/users/matt-aitken/received_events" + }, + "node_id": "MI_kwDOIxVdCc4AiG_o", + "html_url": "https://github.com/triggerdotdev/trigger.dev-examples/milestone/1", + "closed_at": null, + "created_at": "2023-01-19T03:02:37Z", + "labels_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/milestones/1/labels", + "updated_at": "2023-01-19T17:21:25Z", + "description": "", + "open_issues": 1, + "closed_issues": 0 + }, + "reactions": { + "+1": 0, + "-1": 0, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/1/reactions", + "eyes": 0, + "heart": 0, + "laugh": 0, + "hooray": 0, + "rocket": 0, + "confused": 0, + "total_count": 0 + }, + "created_at": "2023-01-19T02:50:49Z", + "events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/1/events", + "labels_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/1/labels{/name}", + "updated_at": "2023-01-24T04:18:52Z", + "comments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/1/comments", + "state_reason": "reopened", + "timeline_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/1/timeline", + "repository_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples", + "active_lock_reason": null, + "author_association": "MEMBER", + "performed_via_github_app": null + }, + "action": "created", + "sender": { + "id": 534, + "url": "https://api.github.com/users/ericallam", + "type": "User", + "login": "ericallam", + "node_id": "MDQ6VXNlcjUzNA==", + "html_url": "https://github.com/ericallam", + "gists_url": "https://api.github.com/users/ericallam/gists{/gist_id}", + "repos_url": "https://api.github.com/users/ericallam/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/534?v=4", + "events_url": "https://api.github.com/users/ericallam/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/ericallam/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/ericallam/followers", + "following_url": "https://api.github.com/users/ericallam/following{/other_user}", + "organizations_url": "https://api.github.com/users/ericallam/orgs", + "subscriptions_url": "https://api.github.com/users/ericallam/subscriptions", + "received_events_url": "https://api.github.com/users/ericallam/received_events" + }, + "comment": { + "id": 1401375866, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/comments/1401375866", + "body": "New comment", + "user": { + "id": 534, + "url": "https://api.github.com/users/ericallam", + "type": "User", + "login": "ericallam", + "node_id": "MDQ6VXNlcjUzNA==", + "html_url": "https://github.com/ericallam", + "gists_url": "https://api.github.com/users/ericallam/gists{/gist_id}", + "repos_url": "https://api.github.com/users/ericallam/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/534?v=4", + "events_url": "https://api.github.com/users/ericallam/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/ericallam/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/ericallam/followers", + "following_url": "https://api.github.com/users/ericallam/following{/other_user}", + "organizations_url": "https://api.github.com/users/ericallam/orgs", + "subscriptions_url": "https://api.github.com/users/ericallam/subscriptions", + "received_events_url": "https://api.github.com/users/ericallam/received_events" + }, + "node_id": "IC_kwDOIxVdCc5Th0x6", + "html_url": "https://github.com/triggerdotdev/trigger.dev-examples/issues/1#issuecomment-1401375866", + "issue_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/1", + "reactions": { + "+1": 0, + "-1": 0, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/comments/1401375866/reactions", + "eyes": 0, + "heart": 0, + "laugh": 0, + "hooray": 0, + "rocket": 0, + "confused": 0, + "total_count": 0 + }, + "created_at": "2023-01-24T04:18:52Z", + "updated_at": "2023-01-24T04:18:52Z", + "author_association": "MEMBER", + "performed_via_github_app": null + }, + "repository": { + "id": 588602633, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples", + "fork": false, + "name": "trigger.dev-examples", + "size": 161, + "forks": 0, + "owner": { + "id": 95297378, + "url": "https://api.github.com/users/triggerdotdev", + "type": "Organization", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "html_url": "https://github.com/triggerdotdev", + "gists_url": "https://api.github.com/users/triggerdotdev/gists{/gist_id}", + "repos_url": "https://api.github.com/users/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/users/triggerdotdev/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/triggerdotdev/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/triggerdotdev/followers", + "following_url": "https://api.github.com/users/triggerdotdev/following{/other_user}", + "organizations_url": "https://api.github.com/users/triggerdotdev/orgs", + "subscriptions_url": "https://api.github.com/users/triggerdotdev/subscriptions", + "received_events_url": "https://api.github.com/users/triggerdotdev/received_events" + }, + "topics": [], + "git_url": "git://github.com/triggerdotdev/trigger.dev-examples.git", + "license": null, + "node_id": "R_kgDOIxVdCQ", + "private": false, + "ssh_url": "git@github.com:triggerdotdev/trigger.dev-examples.git", + "svn_url": "https://github.com/triggerdotdev/trigger.dev-examples", + "archived": false, + "disabled": false, + "has_wiki": false, + "homepage": null, + "html_url": "https://github.com/triggerdotdev/trigger.dev-examples", + "keys_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/keys{/key_id}", + "language": "TypeScript", + "tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/tags", + "watchers": 1, + "blobs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/blobs{/sha}", + "clone_url": "https://github.com/triggerdotdev/trigger.dev-examples.git", + "forks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/forks", + "full_name": "triggerdotdev/trigger.dev-examples", + "has_pages": false, + "hooks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/hooks", + "pulls_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls{/number}", + "pushed_at": "2023-01-23T19:06:36Z", + "teams_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/teams", + "trees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/trees{/sha}", + "created_at": "2023-01-13T14:26:45Z", + "events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/events", + "has_issues": true, + "issues_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues{/number}", + "labels_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/labels{/name}", + "merges_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/merges", + "mirror_url": null, + "updated_at": "2023-01-23T14:22:40Z", + "visibility": "public", + "archive_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/{archive_format}{/ref}", + "commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/commits{/sha}", + "compare_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/compare/{base}...{head}", + "description": "Node.js project with multiple example Trigger.dev workflows", + "forks_count": 0, + "is_template": false, + "open_issues": 2, + "branches_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/branches{/branch}", + "comments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/comments{/number}", + "contents_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/contents/{+path}", + "git_refs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/tags{/sha}", + "has_projects": true, + "releases_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/releases{/id}", + "statuses_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/statuses/{sha}", + "allow_forking": true, + "assignees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/assignees{/user}", + "downloads_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/downloads", + "has_downloads": false, + "languages_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/languages", + "default_branch": "main", + "milestones_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/milestones{/number}", + "stargazers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/stargazers", + "watchers_count": 1, + "deployments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/deployments", + "git_commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/commits{/sha}", + "has_discussions": false, + "subscribers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/subscribers", + "contributors_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/contributors", + "issue_events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/events{/number}", + "stargazers_count": 1, + "subscription_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/subscription", + "collaborators_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/collaborators{/collaborator}", + "issue_comment_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/comments{/number}", + "notifications_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/notifications{?since,all,participating}", + "open_issues_count": 2, + "web_commit_signoff_required": false + }, + "organization": { + "id": 95297378, + "url": "https://api.github.com/orgs/triggerdotdev", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "hooks_url": "https://api.github.com/orgs/triggerdotdev/hooks", + "repos_url": "https://api.github.com/orgs/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/orgs/triggerdotdev/events", + "issues_url": "https://api.github.com/orgs/triggerdotdev/issues", + "description": "", + "members_url": "https://api.github.com/orgs/triggerdotdev/members{/member}", + "public_members_url": "https://api.github.com/orgs/triggerdotdev/public_members{/member}" + } +} +``` diff --git a/apps/docs/integrations/apis/github/events/issues.mdx b/apps/docs/integrations/apis/github/events/issues.mdx new file mode 100644 index 00000000000..d1de2469582 --- /dev/null +++ b/apps/docs/integrations/apis/github/events/issues.mdx @@ -0,0 +1,428 @@ +--- +title: "Issue Event" +sidebarTitle: "Issues" +description: "Trigger a workflow whenever an issue action is performed in a GitHub repository." +--- + +## Usage + +```ts +import { github } from "@trigger.dev/integrations"; + +new Trigger({ + id: "demo", + on: github.events.issueEvent({ + repo: "triggerdotdev/trigger.dev", + }), + run: async (event, ctx) => {}, +}).listen(); +``` + +## Params + + + The full path to the repository, including the organization + + +## Event + + + The issue action, can be one of assigned, closed, deleted, edited, labeled, + unlabeled, locked, opened, pinned, reopened, transferred, unlocked, or + unassigned. + + + + The issue object. + + + + A repository on GitHub. + + + + The GitHub user object who performed the action. + + + + The organization object the repository belongs to. + + +## Additional event fields + +### transferred issues + + + + + The new issue object. + + + + The new issue repository. + + + + + +### edited issues + + + + + + + The previous body text. + + + + + + + + The previous title text. + + + + + + + +### labeled/unlabeled issues + + + The label object. + + +### assigned/unassigned issues + + + The assignee object. + + +### opened issues + + + + + The old issue object. + + + + The old issue repository. + + + + + +## Example Workflows + + + +```typescript Notify Slack on Critical Issue +new Trigger({ + id: "github-to-slack", + name: "Notify of critical issues", + on: github.events.issueEvent({ + repo: "triggerdotdev/trigger.dev", + }), + run: async (event, ctx) => { + if (event.action === "labeled") { + if (event.label?.name === "critical") { + await slack.postMessage("send-to-slack", { + channelName: "serious-issues", + text: `Critical issue: ${event.issue.title} was labeled ${event.label.name}`, + }); + } + } + + return event; + }, +}).listen(); +``` + + + +## Example Event payload + +```json +{ + "issue": { + "id": 1514714160, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev/issues/2", + "body": "This is the body text\r\n`const name = \"Matt\"`", + "user": { + "id": 10635986, + "url": "https://api.github.com/users/matt-aitken", + "type": "User", + "login": "matt-aitken", + "node_id": "MDQ6VXNlcjEwNjM1OTg2", + "html_url": "https://github.com/matt-aitken", + "gists_url": "https://api.github.com/users/matt-aitken/gists{/gist_id}", + "repos_url": "https://api.github.com/users/matt-aitken/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/10635986?v=4", + "events_url": "https://api.github.com/users/matt-aitken/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/matt-aitken/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/matt-aitken/followers", + "following_url": "https://api.github.com/users/matt-aitken/following{/other_user}", + "organizations_url": "https://api.github.com/users/matt-aitken/orgs", + "subscriptions_url": "https://api.github.com/users/matt-aitken/subscriptions", + "received_events_url": "https://api.github.com/users/matt-aitken/received_events" + }, + "state": "open", + "title": "Test issue for webhook", + "labels": [ + { + "id": 4858587614, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev/labels/documentation", + "name": "documentation", + "color": "0075ca", + "default": true, + "node_id": "LA_kwDOIiC6Ac8AAAABIZgp3g", + "description": "Improvements or additions to documentation" + }, + { + "id": 5009913913, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev/labels/critical", + "name": "critical", + "color": "e99695", + "default": false, + "node_id": "LA_kwDOIiC6Ac8AAAABKp04OQ", + "description": "" + } + ], + "locked": false, + "number": 2, + "node_id": "I_kwDOIiC6Ac5aSLQw", + "assignee": { + "id": 10635986, + "url": "https://api.github.com/users/matt-aitken", + "type": "User", + "login": "matt-aitken", + "node_id": "MDQ6VXNlcjEwNjM1OTg2", + "html_url": "https://github.com/matt-aitken", + "gists_url": "https://api.github.com/users/matt-aitken/gists{/gist_id}", + "repos_url": "https://api.github.com/users/matt-aitken/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/10635986?v=4", + "events_url": "https://api.github.com/users/matt-aitken/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/matt-aitken/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/matt-aitken/followers", + "following_url": "https://api.github.com/users/matt-aitken/following{/other_user}", + "organizations_url": "https://api.github.com/users/matt-aitken/orgs", + "subscriptions_url": "https://api.github.com/users/matt-aitken/subscriptions", + "received_events_url": "https://api.github.com/users/matt-aitken/received_events" + }, + "comments": 2, + "html_url": "https://github.com/triggerdotdev/trigger.dev/issues/2", + "assignees": [ + { + "id": 10635986, + "url": "https://api.github.com/users/matt-aitken", + "type": "User", + "login": "matt-aitken", + "node_id": "MDQ6VXNlcjEwNjM1OTg2", + "html_url": "https://github.com/matt-aitken", + "gists_url": "https://api.github.com/users/matt-aitken/gists{/gist_id}", + "repos_url": "https://api.github.com/users/matt-aitken/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/10635986?v=4", + "events_url": "https://api.github.com/users/matt-aitken/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/matt-aitken/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/matt-aitken/followers", + "following_url": "https://api.github.com/users/matt-aitken/following{/other_user}", + "organizations_url": "https://api.github.com/users/matt-aitken/orgs", + "subscriptions_url": "https://api.github.com/users/matt-aitken/subscriptions", + "received_events_url": "https://api.github.com/users/matt-aitken/received_events" + } + ], + "closed_at": null, + "milestone": null, + "reactions": { + "+1": 0, + "-1": 0, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev/issues/2/reactions", + "eyes": 0, + "heart": 0, + "laugh": 0, + "hooray": 0, + "rocket": 0, + "confused": 0, + "total_count": 0 + }, + "created_at": "2022-12-30T18:34:01Z", + "events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/issues/2/events", + "labels_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/issues/2/labels{/name}", + "updated_at": "2023-01-15T20:18:14Z", + "comments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/issues/2/comments", + "state_reason": null, + "timeline_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/issues/2/timeline", + "repository_url": "https://api.github.com/repos/triggerdotdev/trigger.dev", + "active_lock_reason": null, + "author_association": "MEMBER", + "performed_via_github_app": null + }, + "label": { + "id": 5009913913, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev/labels/critical", + "name": "critical", + "color": "e99695", + "default": false, + "node_id": "LA_kwDOIiC6Ac8AAAABKp04OQ", + "description": "" + }, + "action": "labeled", + "sender": { + "id": 7555566, + "url": "https://api.github.com/users/samejr", + "type": "User", + "login": "samejr", + "node_id": "MDQ6VXNlcjc1NTU1NjY=", + "html_url": "https://github.com/samejr", + "gists_url": "https://api.github.com/users/samejr/gists{/gist_id}", + "repos_url": "https://api.github.com/users/samejr/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/7555566?v=4", + "events_url": "https://api.github.com/users/samejr/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/samejr/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/samejr/followers", + "following_url": "https://api.github.com/users/samejr/following{/other_user}", + "organizations_url": "https://api.github.com/users/samejr/orgs", + "subscriptions_url": "https://api.github.com/users/samejr/subscriptions", + "received_events_url": "https://api.github.com/users/samejr/received_events" + }, + "repository": { + "id": 572570113, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev", + "fork": false, + "name": "trigger.dev", + "size": 14727, + "forks": 2, + "owner": { + "id": 95297378, + "url": "https://api.github.com/users/triggerdotdev", + "type": "Organization", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "html_url": "https://github.com/triggerdotdev", + "gists_url": "https://api.github.com/users/triggerdotdev/gists{/gist_id}", + "repos_url": "https://api.github.com/users/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/users/triggerdotdev/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/triggerdotdev/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/triggerdotdev/followers", + "following_url": "https://api.github.com/users/triggerdotdev/following{/other_user}", + "organizations_url": "https://api.github.com/users/triggerdotdev/orgs", + "subscriptions_url": "https://api.github.com/users/triggerdotdev/subscriptions", + "received_events_url": "https://api.github.com/users/triggerdotdev/received_events" + }, + "topics": [ + "apis", + "automation", + "event-driven", + "events", + "orchestration", + "scheduler", + "workflows" + ], + "git_url": "git://github.com/triggerdotdev/trigger.dev.git", + "license": { + "key": "apache-2.0", + "url": "https://api.github.com/licenses/apache-2.0", + "name": "Apache License 2.0", + "node_id": "MDc6TGljZW5zZTI=", + "spdx_id": "Apache-2.0" + }, + "node_id": "R_kgDOIiC6AQ", + "private": false, + "ssh_url": "git@github.com:triggerdotdev/trigger.dev.git", + "svn_url": "https://github.com/triggerdotdev/trigger.dev", + "archived": false, + "disabled": false, + "has_wiki": true, + "homepage": "https://trigger.dev", + "html_url": "https://github.com/triggerdotdev/trigger.dev", + "keys_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/keys{/key_id}", + "language": "TypeScript", + "tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/tags", + "watchers": 58, + "blobs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/git/blobs{/sha}", + "clone_url": "https://github.com/triggerdotdev/trigger.dev.git", + "forks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/forks", + "full_name": "triggerdotdev/trigger.dev", + "has_pages": false, + "hooks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/hooks", + "pulls_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/pulls{/number}", + "pushed_at": "2023-01-15T19:41:24Z", + "teams_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/teams", + "trees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/git/trees{/sha}", + "created_at": "2022-11-30T14:59:07Z", + "events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/events", + "has_issues": true, + "issues_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/issues{/number}", + "labels_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/labels{/name}", + "merges_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/merges", + "mirror_url": null, + "updated_at": "2023-01-15T18:49:01Z", + "visibility": "public", + "archive_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/{archive_format}{/ref}", + "commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/commits{/sha}", + "compare_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/compare/{base}...{head}", + "description": "The developer-first, open source Zapier Alternative. Coming soon. Give us a ⭐️ and we'll let you know", + "forks_count": 2, + "is_template": false, + "open_issues": 2, + "branches_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/branches{/branch}", + "comments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/comments{/number}", + "contents_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/contents/{+path}", + "git_refs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/git/tags{/sha}", + "has_projects": true, + "releases_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/releases{/id}", + "statuses_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/statuses/{sha}", + "allow_forking": true, + "assignees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/assignees{/user}", + "downloads_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/downloads", + "has_downloads": true, + "languages_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/languages", + "default_branch": "main", + "milestones_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/milestones{/number}", + "stargazers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/stargazers", + "watchers_count": 58, + "deployments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/deployments", + "git_commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/git/commits{/sha}", + "has_discussions": false, + "subscribers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/subscribers", + "contributors_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/contributors", + "issue_events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/issues/events{/number}", + "stargazers_count": 58, + "subscription_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/subscription", + "collaborators_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/collaborators{/collaborator}", + "issue_comment_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/issues/comments{/number}", + "notifications_url": "https://api.github.com/repos/triggerdotdev/trigger.dev/notifications{?since,all,participating}", + "open_issues_count": 2, + "web_commit_signoff_required": false + }, + "organization": { + "id": 95297378, + "url": "https://api.github.com/orgs/triggerdotdev", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "hooks_url": "https://api.github.com/orgs/triggerdotdev/hooks", + "repos_url": "https://api.github.com/orgs/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/orgs/triggerdotdev/events", + "issues_url": "https://api.github.com/orgs/triggerdotdev/issues", + "description": "", + "members_url": "https://api.github.com/orgs/triggerdotdev/members{/member}", + "public_members_url": "https://api.github.com/orgs/triggerdotdev/public_members{/member}" + } +} +``` diff --git a/apps/docs/integrations/apis/github/events/new-star.mdx b/apps/docs/integrations/apis/github/events/new-star.mdx index 18ce49d0f53..db772559a8b 100644 --- a/apps/docs/integrations/apis/github/events/new-star.mdx +++ b/apps/docs/integrations/apis/github/events/new-star.mdx @@ -4,9 +4,19 @@ sidebarTitle: "New Star" description: "Trigger a workflow whenever a user star's the specified GitHub repository." --- -# New Star +## Usage -Trigger a workflow whenever a user star's the specified GitHub repository. +```ts +import { github } from "@trigger.dev/integrations"; + +new Trigger({ + id: "demo", + on: github.events.newStarEvent({ + repo: "triggerdotdev/trigger.dev", + }), + run: async (event, ctx) => {}, +}).listen(); +``` ## Params @@ -40,17 +50,6 @@ Trigger a workflow whenever a user star's the specified GitHub repository. -```typescript Basic -new Trigger({ - id: "new-star", - name: "On New Star", - on: github.events.newStarEvent({ - repo: "triggerdotdev/trigger.dev", - }), - run: async (event, ctx) => {}, -}).listen(); -``` - ```typescript Notify Slack on New Star import { slack } from "@trigger.dev/integrations"; diff --git a/apps/docs/integrations/apis/github/events/pull-request-comments.mdx b/apps/docs/integrations/apis/github/events/pull-request-comments.mdx new file mode 100644 index 00000000000..c76a961e2f1 --- /dev/null +++ b/apps/docs/integrations/apis/github/events/pull-request-comments.mdx @@ -0,0 +1,97 @@ +--- +title: "PR Review Comment Event" +sidebarTitle: "PR Review Comments" +description: "Trigger a workflow whenever an pull_request_review_comment action is performed in a GitHub repository." +--- + + + If you would like to trigger a workflow when a comment is made on a PR, use + the [issueCommentEvent](/integrations/apis/github/events/issue-comments) + instead + + +## Usage + +```ts +import { github } from "@trigger.dev/integrations"; + +new Trigger({ + id: "demo", + on: github.events.pullRequestCommentEvent({ + repo: "triggerdotdev/trigger.dev", + }), + run: async (event, ctx) => {}, +}).listen(); +``` + +## Params + + + The full path to the repository, including the organization + + +## Event + + + The pull_request action, can be one of: `created`, `edited`, `deleted`. + + + + The pull request review comment object. + + + + The pull request object. + + + + A repository on GitHub. + + + + The GitHub user object who performed the action. + + + + The organization object the repository belongs to. + + +## Additional event fields + +### edited PR Review Comment + + + + + + + The previous body text. + + + + + + +## Example Workflows + + + +```typescript Notify Slack on new PR +new Trigger({ + id: "new-pr", + name: "Notify Slack on new PR Review Comment", + on: github.events.pullRequestCommentEvent({ + repo: "triggerdotdev/trigger.dev", + }), + run: async (event, ctx) => { + if (event.action === "created") { + await slack.postMessage("New PR comment", { + channelName: "github-prs", + text: `New PR comment by ${event.sender.login} on PR ${event.pull_request.title} (${event.pull_request.html_url})`, + }); + } + }, +}).listen(); +``` + + diff --git a/apps/docs/integrations/apis/github/events/pull-request-reviews.mdx b/apps/docs/integrations/apis/github/events/pull-request-reviews.mdx new file mode 100644 index 00000000000..4f370b9e785 --- /dev/null +++ b/apps/docs/integrations/apis/github/events/pull-request-reviews.mdx @@ -0,0 +1,625 @@ +--- +title: "PR Review Event" +sidebarTitle: "PR Reviews" +description: "Trigger a workflow whenever an pull_request_review action is performed in a GitHub repository." +--- + +## Usage + +```ts +import { github } from "@trigger.dev/integrations"; + +new Trigger({ + id: "demo", + on: github.events.pullRequestReviewEvent({ + repo: "triggerdotdev/trigger.dev", + }), + run: async (event, ctx) => {}, +}).listen(); +``` + +## Params + + + The full path to the repository, including the organization + + +## Event + + + The pull_request_review action, can be one of: `submitted`, `edited`, + `dismissed`. + + + + The pull request review object. + + + + The pull request object. + + + + A repository on GitHub. + + + + The GitHub user object who performed the action. + + + + The organization object the repository belongs to. + + +## Additional event fields + +### edited PR Review + + + + + + + The previous body text. + + + + + + +## Example Workflows + + + +```typescript Notify Slack on new PR Review +new Trigger({ + id: "new-pr", + name: "Notify Slack on new PR Review", + on: github.events.pullRequestReviewEvent({ + repo: "triggerdotdev/trigger.dev", + }), + run: async (event, ctx) => { + if (event.action === "submitted") { + await slack.postMessage("New PR Review", { + channelName: "github-prs", + text: `New PR Review by ${event.sender.login} on PR ${event.pull_request.title} (${event.pull_request.html_url})`, + }); + } + }, +}).listen(); +``` + + + +## Example Event payload + +```json +{ + "action": "submitted", + "review": { + "id": 1266763458, + "body": "This is a PR review comment?", + "user": { + "id": 534, + "url": "https://api.github.com/users/ericallam", + "type": "User", + "login": "ericallam", + "node_id": "MDQ6VXNlcjUzNA==", + "html_url": "https://github.com/ericallam", + "gists_url": "https://api.github.com/users/ericallam/gists{/gist_id}", + "repos_url": "https://api.github.com/users/ericallam/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/534?v=4", + "events_url": "https://api.github.com/users/ericallam/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/ericallam/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/ericallam/followers", + "following_url": "https://api.github.com/users/ericallam/following{/other_user}", + "organizations_url": "https://api.github.com/users/ericallam/orgs", + "subscriptions_url": "https://api.github.com/users/ericallam/subscriptions", + "received_events_url": "https://api.github.com/users/ericallam/received_events" + }, + "state": "commented", + "_links": { + "html": { + "href": "https://github.com/triggerdotdev/trigger.dev-examples/pull/4#pullrequestreview-1266763458" + }, + "pull_request": { + "href": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/4" + } + }, + "node_id": "PRR_kwDOIxVdCc5LgUbC", + "html_url": "https://github.com/triggerdotdev/trigger.dev-examples/pull/4#pullrequestreview-1266763458", + "commit_id": "efc58e149c06f4a45ebf7a0bf34ac25cdcd34b07", + "submitted_at": "2023-01-24T04:24:58Z", + "pull_request_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/4", + "author_association": "MEMBER" + }, + "sender": { + "id": 534, + "url": "https://api.github.com/users/ericallam", + "type": "User", + "login": "ericallam", + "node_id": "MDQ6VXNlcjUzNA==", + "html_url": "https://github.com/ericallam", + "gists_url": "https://api.github.com/users/ericallam/gists{/gist_id}", + "repos_url": "https://api.github.com/users/ericallam/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/534?v=4", + "events_url": "https://api.github.com/users/ericallam/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/ericallam/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/ericallam/followers", + "following_url": "https://api.github.com/users/ericallam/following{/other_user}", + "organizations_url": "https://api.github.com/users/ericallam/orgs", + "subscriptions_url": "https://api.github.com/users/ericallam/subscriptions", + "received_events_url": "https://api.github.com/users/ericallam/received_events" + }, + "repository": { + "id": 588602633, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples", + "fork": false, + "name": "trigger.dev-examples", + "size": 161, + "forks": 0, + "owner": { + "id": 95297378, + "url": "https://api.github.com/users/triggerdotdev", + "type": "Organization", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "html_url": "https://github.com/triggerdotdev", + "gists_url": "https://api.github.com/users/triggerdotdev/gists{/gist_id}", + "repos_url": "https://api.github.com/users/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/users/triggerdotdev/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/triggerdotdev/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/triggerdotdev/followers", + "following_url": "https://api.github.com/users/triggerdotdev/following{/other_user}", + "organizations_url": "https://api.github.com/users/triggerdotdev/orgs", + "subscriptions_url": "https://api.github.com/users/triggerdotdev/subscriptions", + "received_events_url": "https://api.github.com/users/triggerdotdev/received_events" + }, + "topics": [], + "git_url": "git://github.com/triggerdotdev/trigger.dev-examples.git", + "license": null, + "node_id": "R_kgDOIxVdCQ", + "private": false, + "ssh_url": "git@github.com:triggerdotdev/trigger.dev-examples.git", + "svn_url": "https://github.com/triggerdotdev/trigger.dev-examples", + "archived": false, + "disabled": false, + "has_wiki": false, + "homepage": null, + "html_url": "https://github.com/triggerdotdev/trigger.dev-examples", + "keys_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/keys{/key_id}", + "language": "TypeScript", + "tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/tags", + "watchers": 1, + "blobs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/blobs{/sha}", + "clone_url": "https://github.com/triggerdotdev/trigger.dev-examples.git", + "forks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/forks", + "full_name": "triggerdotdev/trigger.dev-examples", + "has_pages": false, + "hooks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/hooks", + "pulls_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls{/number}", + "pushed_at": "2023-01-24T04:20:52Z", + "teams_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/teams", + "trees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/trees{/sha}", + "created_at": "2023-01-13T14:26:45Z", + "events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/events", + "has_issues": true, + "issues_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues{/number}", + "labels_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/labels{/name}", + "merges_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/merges", + "mirror_url": null, + "updated_at": "2023-01-23T14:22:40Z", + "visibility": "public", + "archive_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/{archive_format}{/ref}", + "commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/commits{/sha}", + "compare_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/compare/{base}...{head}", + "description": "Node.js project with multiple example Trigger.dev workflows", + "forks_count": 0, + "is_template": false, + "open_issues": 3, + "branches_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/branches{/branch}", + "comments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/comments{/number}", + "contents_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/contents/{+path}", + "git_refs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/tags{/sha}", + "has_projects": true, + "releases_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/releases{/id}", + "statuses_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/statuses/{sha}", + "allow_forking": true, + "assignees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/assignees{/user}", + "downloads_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/downloads", + "has_downloads": false, + "languages_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/languages", + "default_branch": "main", + "milestones_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/milestones{/number}", + "stargazers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/stargazers", + "watchers_count": 1, + "deployments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/deployments", + "git_commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/commits{/sha}", + "has_discussions": false, + "subscribers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/subscribers", + "contributors_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/contributors", + "issue_events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/events{/number}", + "stargazers_count": 1, + "subscription_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/subscription", + "collaborators_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/collaborators{/collaborator}", + "issue_comment_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/comments{/number}", + "notifications_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/notifications{?since,all,participating}", + "open_issues_count": 3, + "web_commit_signoff_required": false + }, + "organization": { + "id": 95297378, + "url": "https://api.github.com/orgs/triggerdotdev", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "hooks_url": "https://api.github.com/orgs/triggerdotdev/hooks", + "repos_url": "https://api.github.com/orgs/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/orgs/triggerdotdev/events", + "issues_url": "https://api.github.com/orgs/triggerdotdev/issues", + "description": "", + "members_url": "https://api.github.com/orgs/triggerdotdev/members{/member}", + "public_members_url": "https://api.github.com/orgs/triggerdotdev/public_members{/member}" + }, + "pull_request": { + "id": 1214500311, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/4", + "base": { + "ref": "main", + "sha": "e7c0680e23fcd3e52d35ddfbb4076112c640d9fa", + "repo": { + "id": 588602633, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples", + "fork": false, + "name": "trigger.dev-examples", + "size": 161, + "forks": 0, + "owner": { + "id": 95297378, + "url": "https://api.github.com/users/triggerdotdev", + "type": "Organization", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "html_url": "https://github.com/triggerdotdev", + "gists_url": "https://api.github.com/users/triggerdotdev/gists{/gist_id}", + "repos_url": "https://api.github.com/users/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/users/triggerdotdev/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/triggerdotdev/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/triggerdotdev/followers", + "following_url": "https://api.github.com/users/triggerdotdev/following{/other_user}", + "organizations_url": "https://api.github.com/users/triggerdotdev/orgs", + "subscriptions_url": "https://api.github.com/users/triggerdotdev/subscriptions", + "received_events_url": "https://api.github.com/users/triggerdotdev/received_events" + }, + "topics": [], + "git_url": "git://github.com/triggerdotdev/trigger.dev-examples.git", + "license": null, + "node_id": "R_kgDOIxVdCQ", + "private": false, + "ssh_url": "git@github.com:triggerdotdev/trigger.dev-examples.git", + "svn_url": "https://github.com/triggerdotdev/trigger.dev-examples", + "archived": false, + "disabled": false, + "has_wiki": false, + "homepage": null, + "html_url": "https://github.com/triggerdotdev/trigger.dev-examples", + "keys_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/keys{/key_id}", + "language": "TypeScript", + "tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/tags", + "watchers": 1, + "blobs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/blobs{/sha}", + "clone_url": "https://github.com/triggerdotdev/trigger.dev-examples.git", + "forks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/forks", + "full_name": "triggerdotdev/trigger.dev-examples", + "has_pages": false, + "hooks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/hooks", + "pulls_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls{/number}", + "pushed_at": "2023-01-24T04:20:52Z", + "teams_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/teams", + "trees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/trees{/sha}", + "created_at": "2023-01-13T14:26:45Z", + "events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/events", + "has_issues": true, + "issues_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues{/number}", + "labels_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/labels{/name}", + "merges_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/merges", + "mirror_url": null, + "updated_at": "2023-01-23T14:22:40Z", + "visibility": "public", + "archive_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/{archive_format}{/ref}", + "commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/commits{/sha}", + "compare_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/compare/{base}...{head}", + "description": "Node.js project with multiple example Trigger.dev workflows", + "forks_count": 0, + "is_template": false, + "open_issues": 3, + "branches_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/branches{/branch}", + "comments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/comments{/number}", + "contents_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/contents/{+path}", + "git_refs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/tags{/sha}", + "has_projects": true, + "releases_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/releases{/id}", + "statuses_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/statuses/{sha}", + "allow_forking": true, + "assignees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/assignees{/user}", + "downloads_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/downloads", + "has_downloads": false, + "languages_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/languages", + "default_branch": "main", + "milestones_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/milestones{/number}", + "stargazers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/stargazers", + "watchers_count": 1, + "deployments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/deployments", + "git_commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/commits{/sha}", + "has_discussions": false, + "subscribers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/subscribers", + "allow_auto_merge": false, + "contributors_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/contributors", + "issue_events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/events{/number}", + "stargazers_count": 1, + "subscription_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/subscription", + "collaborators_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/collaborators{/collaborator}", + "issue_comment_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/comments{/number}", + "notifications_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/notifications{?since,all,participating}", + "open_issues_count": 3, + "allow_merge_commit": true, + "allow_rebase_merge": true, + "allow_squash_merge": true, + "merge_commit_title": "MERGE_MESSAGE", + "allow_update_branch": false, + "merge_commit_message": "PR_TITLE", + "delete_branch_on_merge": false, + "squash_merge_commit_title": "COMMIT_OR_PR_TITLE", + "squash_merge_commit_message": "COMMIT_MESSAGES", + "web_commit_signoff_required": false, + "use_squash_pr_title_as_default": false + }, + "user": { + "id": 95297378, + "url": "https://api.github.com/users/triggerdotdev", + "type": "Organization", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "html_url": "https://github.com/triggerdotdev", + "gists_url": "https://api.github.com/users/triggerdotdev/gists{/gist_id}", + "repos_url": "https://api.github.com/users/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/users/triggerdotdev/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/triggerdotdev/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/triggerdotdev/followers", + "following_url": "https://api.github.com/users/triggerdotdev/following{/other_user}", + "organizations_url": "https://api.github.com/users/triggerdotdev/orgs", + "subscriptions_url": "https://api.github.com/users/triggerdotdev/subscriptions", + "received_events_url": "https://api.github.com/users/triggerdotdev/received_events" + }, + "label": "triggerdotdev:main" + }, + "body": null, + "head": { + "ref": "resend", + "sha": "efc58e149c06f4a45ebf7a0bf34ac25cdcd34b07", + "repo": { + "id": 588602633, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples", + "fork": false, + "name": "trigger.dev-examples", + "size": 161, + "forks": 0, + "owner": { + "id": 95297378, + "url": "https://api.github.com/users/triggerdotdev", + "type": "Organization", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "html_url": "https://github.com/triggerdotdev", + "gists_url": "https://api.github.com/users/triggerdotdev/gists{/gist_id}", + "repos_url": "https://api.github.com/users/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/users/triggerdotdev/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/triggerdotdev/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/triggerdotdev/followers", + "following_url": "https://api.github.com/users/triggerdotdev/following{/other_user}", + "organizations_url": "https://api.github.com/users/triggerdotdev/orgs", + "subscriptions_url": "https://api.github.com/users/triggerdotdev/subscriptions", + "received_events_url": "https://api.github.com/users/triggerdotdev/received_events" + }, + "topics": [], + "git_url": "git://github.com/triggerdotdev/trigger.dev-examples.git", + "license": null, + "node_id": "R_kgDOIxVdCQ", + "private": false, + "ssh_url": "git@github.com:triggerdotdev/trigger.dev-examples.git", + "svn_url": "https://github.com/triggerdotdev/trigger.dev-examples", + "archived": false, + "disabled": false, + "has_wiki": false, + "homepage": null, + "html_url": "https://github.com/triggerdotdev/trigger.dev-examples", + "keys_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/keys{/key_id}", + "language": "TypeScript", + "tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/tags", + "watchers": 1, + "blobs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/blobs{/sha}", + "clone_url": "https://github.com/triggerdotdev/trigger.dev-examples.git", + "forks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/forks", + "full_name": "triggerdotdev/trigger.dev-examples", + "has_pages": false, + "hooks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/hooks", + "pulls_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls{/number}", + "pushed_at": "2023-01-24T04:20:52Z", + "teams_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/teams", + "trees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/trees{/sha}", + "created_at": "2023-01-13T14:26:45Z", + "events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/events", + "has_issues": true, + "issues_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues{/number}", + "labels_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/labels{/name}", + "merges_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/merges", + "mirror_url": null, + "updated_at": "2023-01-23T14:22:40Z", + "visibility": "public", + "archive_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/{archive_format}{/ref}", + "commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/commits{/sha}", + "compare_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/compare/{base}...{head}", + "description": "Node.js project with multiple example Trigger.dev workflows", + "forks_count": 0, + "is_template": false, + "open_issues": 3, + "branches_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/branches{/branch}", + "comments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/comments{/number}", + "contents_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/contents/{+path}", + "git_refs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/tags{/sha}", + "has_projects": true, + "releases_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/releases{/id}", + "statuses_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/statuses/{sha}", + "allow_forking": true, + "assignees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/assignees{/user}", + "downloads_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/downloads", + "has_downloads": false, + "languages_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/languages", + "default_branch": "main", + "milestones_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/milestones{/number}", + "stargazers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/stargazers", + "watchers_count": 1, + "deployments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/deployments", + "git_commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/commits{/sha}", + "has_discussions": false, + "subscribers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/subscribers", + "allow_auto_merge": false, + "contributors_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/contributors", + "issue_events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/events{/number}", + "stargazers_count": 1, + "subscription_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/subscription", + "collaborators_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/collaborators{/collaborator}", + "issue_comment_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/comments{/number}", + "notifications_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/notifications{?since,all,participating}", + "open_issues_count": 3, + "allow_merge_commit": true, + "allow_rebase_merge": true, + "allow_squash_merge": true, + "merge_commit_title": "MERGE_MESSAGE", + "allow_update_branch": false, + "merge_commit_message": "PR_TITLE", + "delete_branch_on_merge": false, + "squash_merge_commit_title": "COMMIT_OR_PR_TITLE", + "squash_merge_commit_message": "COMMIT_MESSAGES", + "web_commit_signoff_required": false, + "use_squash_pr_title_as_default": false + }, + "user": { + "id": 95297378, + "url": "https://api.github.com/users/triggerdotdev", + "type": "Organization", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "html_url": "https://github.com/triggerdotdev", + "gists_url": "https://api.github.com/users/triggerdotdev/gists{/gist_id}", + "repos_url": "https://api.github.com/users/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/users/triggerdotdev/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/triggerdotdev/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/triggerdotdev/followers", + "following_url": "https://api.github.com/users/triggerdotdev/following{/other_user}", + "organizations_url": "https://api.github.com/users/triggerdotdev/orgs", + "subscriptions_url": "https://api.github.com/users/triggerdotdev/subscriptions", + "received_events_url": "https://api.github.com/users/triggerdotdev/received_events" + }, + "label": "triggerdotdev:resend" + }, + "user": { + "id": 534, + "url": "https://api.github.com/users/ericallam", + "type": "User", + "login": "ericallam", + "node_id": "MDQ6VXNlcjUzNA==", + "html_url": "https://github.com/ericallam", + "gists_url": "https://api.github.com/users/ericallam/gists{/gist_id}", + "repos_url": "https://api.github.com/users/ericallam/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/534?v=4", + "events_url": "https://api.github.com/users/ericallam/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/ericallam/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/ericallam/followers", + "following_url": "https://api.github.com/users/ericallam/following{/other_user}", + "organizations_url": "https://api.github.com/users/ericallam/orgs", + "subscriptions_url": "https://api.github.com/users/ericallam/subscriptions", + "received_events_url": "https://api.github.com/users/ericallam/received_events" + }, + "draft": false, + "state": "open", + "title": "Example PR", + "_links": { + "html": { + "href": "https://github.com/triggerdotdev/trigger.dev-examples/pull/4" + }, + "self": { + "href": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/4" + }, + "issue": { + "href": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/4" + }, + "commits": { + "href": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/4/commits" + }, + "comments": { + "href": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/4/comments" + }, + "statuses": { + "href": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/statuses/efc58e149c06f4a45ebf7a0bf34ac25cdcd34b07" + }, + "review_comment": { + "href": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/comments{/number}" + }, + "review_comments": { + "href": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/4/comments" + } + }, + "labels": [], + "locked": false, + "number": 4, + "node_id": "PR_kwDOIxVdCc5IY83X", + "assignee": null, + "diff_url": "https://github.com/triggerdotdev/trigger.dev-examples/pull/4.diff", + "html_url": "https://github.com/triggerdotdev/trigger.dev-examples/pull/4", + "assignees": [], + "closed_at": null, + "issue_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/4", + "merged_at": null, + "milestone": null, + "patch_url": "https://github.com/triggerdotdev/trigger.dev-examples/pull/4.patch", + "auto_merge": null, + "created_at": "2023-01-24T04:20:51Z", + "updated_at": "2023-01-24T04:24:58Z", + "commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/4/commits", + "comments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/4/comments", + "statuses_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/statuses/efc58e149c06f4a45ebf7a0bf34ac25cdcd34b07", + "requested_teams": [], + "merge_commit_sha": null, + "active_lock_reason": null, + "author_association": "MEMBER", + "review_comment_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/comments{/number}", + "requested_reviewers": [], + "review_comments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/4/comments" + } +} +``` diff --git a/apps/docs/integrations/apis/github/events/pull-requests.mdx b/apps/docs/integrations/apis/github/events/pull-requests.mdx new file mode 100644 index 00000000000..be89fe5a7cb --- /dev/null +++ b/apps/docs/integrations/apis/github/events/pull-requests.mdx @@ -0,0 +1,644 @@ +--- +title: "Pull Request Event" +sidebarTitle: "Pull Requests" +description: "Trigger a workflow whenever an pull_request action is performed in a GitHub repository." +--- + +## Usage + +```ts +import { github } from "@trigger.dev/integrations"; + +new Trigger({ + id: "demo", + on: github.events.pullRequestEvent({ + repo: "triggerdotdev/trigger.dev", + }), + run: async (event, ctx) => {}, +}).listen(); +``` + +## Params + + + The full path to the repository, including the organization + + +## Event + + + The pull_request action, which can one of assigned, unassigned, + auto_merge_enabled, auto_merge_disabled, review_requested, + review_request_removed, ready_for_review, labeled, unlabeled, opened, edited, + closed, reopened, synchronize, ready_for_review, locked, unlocked, or + converted_to_draft. + + + + The pull request number. + + + + The pull request object. + + + + A repository on GitHub. + + + + The GitHub user object who performed the action. + + + + The organization object the repository belongs to. + + +## Additional event fields + +### review_requested/review_request_removed PRs + + + The GitHub user object who was requested to review the PR. + + + + The GitHub team object who was requested to review the PR. + + +### labeled/unlabeled PRs + + + The label object. + + +### assigned/unassigned PRs + + + The assignee object. + + +### edited PRs + + + + + + + The previous body text. + + + + + + + + The previous title text. + + + + + + + + Use `ref.from` to get the previous base branch name. + + + Use `sha.from` to get the previous base branch SHA. + + + + + + + +## Example Workflows + + + +```typescript Notify Slack on new PR +new Trigger({ + id: "new-pr", + name: "Notify Slack on new PR", + on: github.events.pullRequestEvent({ + repo: "triggerdotdev/trigger.dev", + }), + run: async (event, ctx) => { + if (event.action === "opened") { + await slack.postMessage("New PR", { + channelName: "github-prs", + text: `New PR: ${event.pull_request.html_url}`, + }); + } + }, +}).listen(); +``` + + + +## Example Event payload + +```json +{ + "action": "opened", + "number": 4, + "sender": { + "id": 534, + "url": "https://api.github.com/users/ericallam", + "type": "User", + "login": "ericallam", + "node_id": "MDQ6VXNlcjUzNA==", + "html_url": "https://github.com/ericallam", + "gists_url": "https://api.github.com/users/ericallam/gists{/gist_id}", + "repos_url": "https://api.github.com/users/ericallam/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/534?v=4", + "events_url": "https://api.github.com/users/ericallam/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/ericallam/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/ericallam/followers", + "following_url": "https://api.github.com/users/ericallam/following{/other_user}", + "organizations_url": "https://api.github.com/users/ericallam/orgs", + "subscriptions_url": "https://api.github.com/users/ericallam/subscriptions", + "received_events_url": "https://api.github.com/users/ericallam/received_events" + }, + "repository": { + "id": 588602633, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples", + "fork": false, + "name": "trigger.dev-examples", + "size": 161, + "forks": 0, + "owner": { + "id": 95297378, + "url": "https://api.github.com/users/triggerdotdev", + "type": "Organization", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "html_url": "https://github.com/triggerdotdev", + "gists_url": "https://api.github.com/users/triggerdotdev/gists{/gist_id}", + "repos_url": "https://api.github.com/users/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/users/triggerdotdev/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/triggerdotdev/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/triggerdotdev/followers", + "following_url": "https://api.github.com/users/triggerdotdev/following{/other_user}", + "organizations_url": "https://api.github.com/users/triggerdotdev/orgs", + "subscriptions_url": "https://api.github.com/users/triggerdotdev/subscriptions", + "received_events_url": "https://api.github.com/users/triggerdotdev/received_events" + }, + "topics": [], + "git_url": "git://github.com/triggerdotdev/trigger.dev-examples.git", + "license": null, + "node_id": "R_kgDOIxVdCQ", + "private": false, + "ssh_url": "git@github.com:triggerdotdev/trigger.dev-examples.git", + "svn_url": "https://github.com/triggerdotdev/trigger.dev-examples", + "archived": false, + "disabled": false, + "has_wiki": false, + "homepage": null, + "html_url": "https://github.com/triggerdotdev/trigger.dev-examples", + "keys_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/keys{/key_id}", + "language": "TypeScript", + "tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/tags", + "watchers": 1, + "blobs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/blobs{/sha}", + "clone_url": "https://github.com/triggerdotdev/trigger.dev-examples.git", + "forks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/forks", + "full_name": "triggerdotdev/trigger.dev-examples", + "has_pages": false, + "hooks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/hooks", + "pulls_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls{/number}", + "pushed_at": "2023-01-24T04:20:52Z", + "teams_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/teams", + "trees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/trees{/sha}", + "created_at": "2023-01-13T14:26:45Z", + "events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/events", + "has_issues": true, + "issues_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues{/number}", + "labels_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/labels{/name}", + "merges_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/merges", + "mirror_url": null, + "updated_at": "2023-01-23T14:22:40Z", + "visibility": "public", + "archive_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/{archive_format}{/ref}", + "commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/commits{/sha}", + "compare_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/compare/{base}...{head}", + "description": "Node.js project with multiple example Trigger.dev workflows", + "forks_count": 0, + "is_template": false, + "open_issues": 3, + "branches_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/branches{/branch}", + "comments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/comments{/number}", + "contents_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/contents/{+path}", + "git_refs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/tags{/sha}", + "has_projects": true, + "releases_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/releases{/id}", + "statuses_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/statuses/{sha}", + "allow_forking": true, + "assignees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/assignees{/user}", + "downloads_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/downloads", + "has_downloads": false, + "languages_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/languages", + "default_branch": "main", + "milestones_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/milestones{/number}", + "stargazers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/stargazers", + "watchers_count": 1, + "deployments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/deployments", + "git_commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/commits{/sha}", + "has_discussions": false, + "subscribers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/subscribers", + "contributors_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/contributors", + "issue_events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/events{/number}", + "stargazers_count": 1, + "subscription_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/subscription", + "collaborators_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/collaborators{/collaborator}", + "issue_comment_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/comments{/number}", + "notifications_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/notifications{?since,all,participating}", + "open_issues_count": 3, + "web_commit_signoff_required": false + }, + "organization": { + "id": 95297378, + "url": "https://api.github.com/orgs/triggerdotdev", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "hooks_url": "https://api.github.com/orgs/triggerdotdev/hooks", + "repos_url": "https://api.github.com/orgs/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/orgs/triggerdotdev/events", + "issues_url": "https://api.github.com/orgs/triggerdotdev/issues", + "description": "", + "members_url": "https://api.github.com/orgs/triggerdotdev/members{/member}", + "public_members_url": "https://api.github.com/orgs/triggerdotdev/public_members{/member}" + }, + "pull_request": { + "id": 1214500311, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/4", + "base": { + "ref": "main", + "sha": "e7c0680e23fcd3e52d35ddfbb4076112c640d9fa", + "repo": { + "id": 588602633, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples", + "fork": false, + "name": "trigger.dev-examples", + "size": 161, + "forks": 0, + "owner": { + "id": 95297378, + "url": "https://api.github.com/users/triggerdotdev", + "type": "Organization", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "html_url": "https://github.com/triggerdotdev", + "gists_url": "https://api.github.com/users/triggerdotdev/gists{/gist_id}", + "repos_url": "https://api.github.com/users/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/users/triggerdotdev/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/triggerdotdev/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/triggerdotdev/followers", + "following_url": "https://api.github.com/users/triggerdotdev/following{/other_user}", + "organizations_url": "https://api.github.com/users/triggerdotdev/orgs", + "subscriptions_url": "https://api.github.com/users/triggerdotdev/subscriptions", + "received_events_url": "https://api.github.com/users/triggerdotdev/received_events" + }, + "topics": [], + "git_url": "git://github.com/triggerdotdev/trigger.dev-examples.git", + "license": null, + "node_id": "R_kgDOIxVdCQ", + "private": false, + "ssh_url": "git@github.com:triggerdotdev/trigger.dev-examples.git", + "svn_url": "https://github.com/triggerdotdev/trigger.dev-examples", + "archived": false, + "disabled": false, + "has_wiki": false, + "homepage": null, + "html_url": "https://github.com/triggerdotdev/trigger.dev-examples", + "keys_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/keys{/key_id}", + "language": "TypeScript", + "tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/tags", + "watchers": 1, + "blobs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/blobs{/sha}", + "clone_url": "https://github.com/triggerdotdev/trigger.dev-examples.git", + "forks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/forks", + "full_name": "triggerdotdev/trigger.dev-examples", + "has_pages": false, + "hooks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/hooks", + "pulls_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls{/number}", + "pushed_at": "2023-01-24T04:20:52Z", + "teams_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/teams", + "trees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/trees{/sha}", + "created_at": "2023-01-13T14:26:45Z", + "events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/events", + "has_issues": true, + "issues_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues{/number}", + "labels_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/labels{/name}", + "merges_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/merges", + "mirror_url": null, + "updated_at": "2023-01-23T14:22:40Z", + "visibility": "public", + "archive_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/{archive_format}{/ref}", + "commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/commits{/sha}", + "compare_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/compare/{base}...{head}", + "description": "Node.js project with multiple example Trigger.dev workflows", + "forks_count": 0, + "is_template": false, + "open_issues": 3, + "branches_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/branches{/branch}", + "comments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/comments{/number}", + "contents_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/contents/{+path}", + "git_refs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/tags{/sha}", + "has_projects": true, + "releases_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/releases{/id}", + "statuses_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/statuses/{sha}", + "allow_forking": true, + "assignees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/assignees{/user}", + "downloads_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/downloads", + "has_downloads": false, + "languages_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/languages", + "default_branch": "main", + "milestones_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/milestones{/number}", + "stargazers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/stargazers", + "watchers_count": 1, + "deployments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/deployments", + "git_commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/commits{/sha}", + "has_discussions": false, + "subscribers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/subscribers", + "allow_auto_merge": false, + "contributors_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/contributors", + "issue_events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/events{/number}", + "stargazers_count": 1, + "subscription_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/subscription", + "collaborators_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/collaborators{/collaborator}", + "issue_comment_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/comments{/number}", + "notifications_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/notifications{?since,all,participating}", + "open_issues_count": 3, + "allow_merge_commit": true, + "allow_rebase_merge": true, + "allow_squash_merge": true, + "merge_commit_title": "MERGE_MESSAGE", + "allow_update_branch": false, + "merge_commit_message": "PR_TITLE", + "delete_branch_on_merge": false, + "squash_merge_commit_title": "COMMIT_OR_PR_TITLE", + "squash_merge_commit_message": "COMMIT_MESSAGES", + "web_commit_signoff_required": false, + "use_squash_pr_title_as_default": false + }, + "user": { + "id": 95297378, + "url": "https://api.github.com/users/triggerdotdev", + "type": "Organization", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "html_url": "https://github.com/triggerdotdev", + "gists_url": "https://api.github.com/users/triggerdotdev/gists{/gist_id}", + "repos_url": "https://api.github.com/users/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/users/triggerdotdev/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/triggerdotdev/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/triggerdotdev/followers", + "following_url": "https://api.github.com/users/triggerdotdev/following{/other_user}", + "organizations_url": "https://api.github.com/users/triggerdotdev/orgs", + "subscriptions_url": "https://api.github.com/users/triggerdotdev/subscriptions", + "received_events_url": "https://api.github.com/users/triggerdotdev/received_events" + }, + "label": "triggerdotdev:main" + }, + "body": null, + "head": { + "ref": "resend", + "sha": "efc58e149c06f4a45ebf7a0bf34ac25cdcd34b07", + "repo": { + "id": 588602633, + "url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples", + "fork": false, + "name": "trigger.dev-examples", + "size": 161, + "forks": 0, + "owner": { + "id": 95297378, + "url": "https://api.github.com/users/triggerdotdev", + "type": "Organization", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "html_url": "https://github.com/triggerdotdev", + "gists_url": "https://api.github.com/users/triggerdotdev/gists{/gist_id}", + "repos_url": "https://api.github.com/users/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/users/triggerdotdev/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/triggerdotdev/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/triggerdotdev/followers", + "following_url": "https://api.github.com/users/triggerdotdev/following{/other_user}", + "organizations_url": "https://api.github.com/users/triggerdotdev/orgs", + "subscriptions_url": "https://api.github.com/users/triggerdotdev/subscriptions", + "received_events_url": "https://api.github.com/users/triggerdotdev/received_events" + }, + "topics": [], + "git_url": "git://github.com/triggerdotdev/trigger.dev-examples.git", + "license": null, + "node_id": "R_kgDOIxVdCQ", + "private": false, + "ssh_url": "git@github.com:triggerdotdev/trigger.dev-examples.git", + "svn_url": "https://github.com/triggerdotdev/trigger.dev-examples", + "archived": false, + "disabled": false, + "has_wiki": false, + "homepage": null, + "html_url": "https://github.com/triggerdotdev/trigger.dev-examples", + "keys_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/keys{/key_id}", + "language": "TypeScript", + "tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/tags", + "watchers": 1, + "blobs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/blobs{/sha}", + "clone_url": "https://github.com/triggerdotdev/trigger.dev-examples.git", + "forks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/forks", + "full_name": "triggerdotdev/trigger.dev-examples", + "has_pages": false, + "hooks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/hooks", + "pulls_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls{/number}", + "pushed_at": "2023-01-24T04:20:52Z", + "teams_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/teams", + "trees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/trees{/sha}", + "created_at": "2023-01-13T14:26:45Z", + "events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/events", + "has_issues": true, + "issues_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues{/number}", + "labels_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/labels{/name}", + "merges_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/merges", + "mirror_url": null, + "updated_at": "2023-01-23T14:22:40Z", + "visibility": "public", + "archive_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/{archive_format}{/ref}", + "commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/commits{/sha}", + "compare_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/compare/{base}...{head}", + "description": "Node.js project with multiple example Trigger.dev workflows", + "forks_count": 0, + "is_template": false, + "open_issues": 3, + "branches_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/branches{/branch}", + "comments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/comments{/number}", + "contents_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/contents/{+path}", + "git_refs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/tags{/sha}", + "has_projects": true, + "releases_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/releases{/id}", + "statuses_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/statuses/{sha}", + "allow_forking": true, + "assignees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/assignees{/user}", + "downloads_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/downloads", + "has_downloads": false, + "languages_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/languages", + "default_branch": "main", + "milestones_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/milestones{/number}", + "stargazers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/stargazers", + "watchers_count": 1, + "deployments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/deployments", + "git_commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/commits{/sha}", + "has_discussions": false, + "subscribers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/subscribers", + "allow_auto_merge": false, + "contributors_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/contributors", + "issue_events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/events{/number}", + "stargazers_count": 1, + "subscription_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/subscription", + "collaborators_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/collaborators{/collaborator}", + "issue_comment_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/comments{/number}", + "notifications_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/notifications{?since,all,participating}", + "open_issues_count": 3, + "allow_merge_commit": true, + "allow_rebase_merge": true, + "allow_squash_merge": true, + "merge_commit_title": "MERGE_MESSAGE", + "allow_update_branch": false, + "merge_commit_message": "PR_TITLE", + "delete_branch_on_merge": false, + "squash_merge_commit_title": "COMMIT_OR_PR_TITLE", + "squash_merge_commit_message": "COMMIT_MESSAGES", + "web_commit_signoff_required": false, + "use_squash_pr_title_as_default": false + }, + "user": { + "id": 95297378, + "url": "https://api.github.com/users/triggerdotdev", + "type": "Organization", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "html_url": "https://github.com/triggerdotdev", + "gists_url": "https://api.github.com/users/triggerdotdev/gists{/gist_id}", + "repos_url": "https://api.github.com/users/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/users/triggerdotdev/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/triggerdotdev/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/triggerdotdev/followers", + "following_url": "https://api.github.com/users/triggerdotdev/following{/other_user}", + "organizations_url": "https://api.github.com/users/triggerdotdev/orgs", + "subscriptions_url": "https://api.github.com/users/triggerdotdev/subscriptions", + "received_events_url": "https://api.github.com/users/triggerdotdev/received_events" + }, + "label": "triggerdotdev:resend" + }, + "user": { + "id": 534, + "url": "https://api.github.com/users/ericallam", + "type": "User", + "login": "ericallam", + "node_id": "MDQ6VXNlcjUzNA==", + "html_url": "https://github.com/ericallam", + "gists_url": "https://api.github.com/users/ericallam/gists{/gist_id}", + "repos_url": "https://api.github.com/users/ericallam/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/534?v=4", + "events_url": "https://api.github.com/users/ericallam/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/ericallam/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/ericallam/followers", + "following_url": "https://api.github.com/users/ericallam/following{/other_user}", + "organizations_url": "https://api.github.com/users/ericallam/orgs", + "subscriptions_url": "https://api.github.com/users/ericallam/subscriptions", + "received_events_url": "https://api.github.com/users/ericallam/received_events" + }, + "draft": false, + "state": "open", + "title": "Example PR", + "_links": { + "html": { + "href": "https://github.com/triggerdotdev/trigger.dev-examples/pull/4" + }, + "self": { + "href": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/4" + }, + "issue": { + "href": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/4" + }, + "commits": { + "href": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/4/commits" + }, + "comments": { + "href": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/4/comments" + }, + "statuses": { + "href": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/statuses/efc58e149c06f4a45ebf7a0bf34ac25cdcd34b07" + }, + "review_comment": { + "href": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/comments{/number}" + }, + "review_comments": { + "href": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/4/comments" + } + }, + "labels": [], + "locked": false, + "merged": false, + "number": 4, + "commits": 1, + "node_id": "PR_kwDOIxVdCc5IY83X", + "assignee": null, + "comments": 0, + "diff_url": "https://github.com/triggerdotdev/trigger.dev-examples/pull/4.diff", + "html_url": "https://github.com/triggerdotdev/trigger.dev-examples/pull/4", + "additions": 220, + "assignees": [], + "closed_at": null, + "deletions": 0, + "issue_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/4", + "mergeable": null, + "merged_at": null, + "merged_by": null, + "milestone": null, + "patch_url": "https://github.com/triggerdotdev/trigger.dev-examples/pull/4.patch", + "auto_merge": null, + "created_at": "2023-01-24T04:20:51Z", + "rebaseable": null, + "updated_at": "2023-01-24T04:20:51Z", + "commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/4/commits", + "comments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/4/comments", + "statuses_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/statuses/efc58e149c06f4a45ebf7a0bf34ac25cdcd34b07", + "changed_files": 3, + "mergeable_state": "unknown", + "requested_teams": [], + "review_comments": 0, + "merge_commit_sha": null, + "active_lock_reason": null, + "author_association": "MEMBER", + "review_comment_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/comments{/number}", + "requested_reviewers": [], + "review_comments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls/4/comments", + "maintainer_can_modify": false + } +} +``` diff --git a/apps/docs/integrations/apis/github/events/push.mdx b/apps/docs/integrations/apis/github/events/push.mdx new file mode 100644 index 00000000000..b41b808b4bf --- /dev/null +++ b/apps/docs/integrations/apis/github/events/push.mdx @@ -0,0 +1,311 @@ +--- +title: "Push Event" +sidebarTitle: "Pushes" +description: "Trigger a workflow whenever a push action is performed in a GitHub repository." +--- + +## Usage + +```ts +import { github } from "@trigger.dev/integrations"; + +new Trigger({ + id: "demo", + on: github.events.pushEvent({ + repo: "triggerdotdev/trigger.dev", + }), + run: async (event, ctx) => {}, +}).listen(); +``` + +## Params + + + The full path to the repository, including the organization + + +## Event + + + The full git ref that was pushed. Example: refs/heads/master. + + + + The SHA of the commit before the push. + + + + The SHA of the commit after the push. + + + + Whether this was a created branch or tag. + + + + Whether this was a deleted branch or tag. + + + + Whether this was a forced update or not. + + + + If the ref is a branch, this is the branch name that the push was made to. + + + + The HTTP URL to compare the two commits. + + + + An array of commit objects describing the pushed commits. + + + + The head commit object. + + + + A repository on GitHub. + + + + The GitHub user object who performed the action. + + + + The organization object the repository belongs to. + + +## Example Workflows + + + +```typescript Notify Slack on new push +new Trigger({ + id: "github-to-slack", + name: "Notify of new push", + on: github.events.pushEvent({ + repo: "triggerdotdev/trigger.dev", + }), + run: async (event, ctx) => { + await slack.postMessage("New push to trigger.dev", { + channel: "github-changes", + text: `New push to trigger.dev by ${event.sender.login}: ${event.compare}`, + }); + }, +}).listen(); +``` + + + +## Example Event payload + +```json +{ + "ref": "refs/heads/main", + "after": "4a0834a1daa09cdd1a03038dbc131f807d887de8", + "before": "e7c0680e23fcd3e52d35ddfbb4076112c640d9fa", + "forced": false, + "pusher": { + "name": "ericallam", + "email": "eallam@icloud.com" + }, + "sender": { + "id": 534, + "url": "https://api.github.com/users/ericallam", + "type": "User", + "login": "ericallam", + "node_id": "MDQ6VXNlcjUzNA==", + "html_url": "https://github.com/ericallam", + "gists_url": "https://api.github.com/users/ericallam/gists{/gist_id}", + "repos_url": "https://api.github.com/users/ericallam/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/534?v=4", + "events_url": "https://api.github.com/users/ericallam/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/ericallam/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/ericallam/followers", + "following_url": "https://api.github.com/users/ericallam/following{/other_user}", + "organizations_url": "https://api.github.com/users/ericallam/orgs", + "subscriptions_url": "https://api.github.com/users/ericallam/subscriptions", + "received_events_url": "https://api.github.com/users/ericallam/received_events" + }, + "commits": [ + { + "id": "4a0834a1daa09cdd1a03038dbc131f807d887de8", + "url": "https://github.com/triggerdotdev/trigger.dev-examples/commit/4a0834a1daa09cdd1a03038dbc131f807d887de8", + "added": [], + "author": { + "name": "Eric Allam", + "email": "eallam@icloud.com", + "username": "ericallam" + }, + "message": "Add some documentation for how to run (needs work)", + "removed": [], + "tree_id": "5c06942324e80422eea4f4c11ff80d4bd8f9d7a7", + "distinct": true, + "modified": [ + "README.md", + "pnpm-lock.yaml", + "src/examples/github-webhook.ts" + ], + "committer": { + "name": "Eric Allam", + "email": "eallam@icloud.com", + "username": "ericallam" + }, + "timestamp": "2023-01-24T04:43:40Z" + } + ], + "compare": "https://github.com/triggerdotdev/trigger.dev-examples/compare/e7c0680e23fc...4a0834a1daa0", + "created": false, + "deleted": false, + "base_ref": null, + "repository": { + "id": 588602633, + "url": "https://github.com/triggerdotdev/trigger.dev-examples", + "fork": false, + "name": "trigger.dev-examples", + "size": 161, + "forks": 0, + "owner": { + "id": 95297378, + "url": "https://api.github.com/users/triggerdotdev", + "name": "triggerdotdev", + "type": "Organization", + "email": "hello@trigger.dev", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "html_url": "https://github.com/triggerdotdev", + "gists_url": "https://api.github.com/users/triggerdotdev/gists{/gist_id}", + "repos_url": "https://api.github.com/users/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/users/triggerdotdev/events{/privacy}", + "site_admin": false, + "gravatar_id": "", + "starred_url": "https://api.github.com/users/triggerdotdev/starred{/owner}{/repo}", + "followers_url": "https://api.github.com/users/triggerdotdev/followers", + "following_url": "https://api.github.com/users/triggerdotdev/following{/other_user}", + "organizations_url": "https://api.github.com/users/triggerdotdev/orgs", + "subscriptions_url": "https://api.github.com/users/triggerdotdev/subscriptions", + "received_events_url": "https://api.github.com/users/triggerdotdev/received_events" + }, + "topics": [], + "git_url": "git://github.com/triggerdotdev/trigger.dev-examples.git", + "license": null, + "node_id": "R_kgDOIxVdCQ", + "private": false, + "ssh_url": "git@github.com:triggerdotdev/trigger.dev-examples.git", + "svn_url": "https://github.com/triggerdotdev/trigger.dev-examples", + "archived": false, + "disabled": false, + "has_wiki": false, + "homepage": null, + "html_url": "https://github.com/triggerdotdev/trigger.dev-examples", + "keys_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/keys{/key_id}", + "language": "TypeScript", + "tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/tags", + "watchers": 1, + "blobs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/blobs{/sha}", + "clone_url": "https://github.com/triggerdotdev/trigger.dev-examples.git", + "forks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/forks", + "full_name": "triggerdotdev/trigger.dev-examples", + "has_pages": false, + "hooks_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/hooks", + "pulls_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/pulls{/number}", + "pushed_at": 1674535423, + "teams_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/teams", + "trees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/trees{/sha}", + "created_at": 1673620005, + "events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/events", + "has_issues": true, + "issues_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues{/number}", + "labels_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/labels{/name}", + "merges_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/merges", + "mirror_url": null, + "stargazers": 1, + "updated_at": "2023-01-23T14:22:40Z", + "visibility": "public", + "archive_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/{archive_format}{/ref}", + "commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/commits{/sha}", + "compare_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/compare/{base}...{head}", + "description": "Node.js project with multiple example Trigger.dev workflows", + "forks_count": 0, + "is_template": false, + "open_issues": 2, + "branches_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/branches{/branch}", + "comments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/comments{/number}", + "contents_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/contents/{+path}", + "git_refs_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/tags{/sha}", + "has_projects": true, + "organization": "triggerdotdev", + "releases_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/releases{/id}", + "statuses_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/statuses/{sha}", + "allow_forking": true, + "assignees_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/assignees{/user}", + "downloads_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/downloads", + "has_downloads": false, + "languages_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/languages", + "master_branch": "main", + "default_branch": "main", + "milestones_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/milestones{/number}", + "stargazers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/stargazers", + "watchers_count": 1, + "deployments_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/deployments", + "git_commits_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/git/commits{/sha}", + "has_discussions": false, + "subscribers_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/subscribers", + "contributors_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/contributors", + "issue_events_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/events{/number}", + "stargazers_count": 1, + "subscription_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/subscription", + "collaborators_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/collaborators{/collaborator}", + "issue_comment_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/issues/comments{/number}", + "notifications_url": "https://api.github.com/repos/triggerdotdev/trigger.dev-examples/notifications{?since,all,participating}", + "open_issues_count": 2, + "web_commit_signoff_required": false + }, + "head_commit": { + "id": "4a0834a1daa09cdd1a03038dbc131f807d887de8", + "url": "https://github.com/triggerdotdev/trigger.dev-examples/commit/4a0834a1daa09cdd1a03038dbc131f807d887de8", + "added": [], + "author": { + "name": "Eric Allam", + "email": "eallam@icloud.com", + "username": "ericallam" + }, + "message": "Add some documentation for how to run (needs work)", + "removed": [], + "tree_id": "5c06942324e80422eea4f4c11ff80d4bd8f9d7a7", + "distinct": true, + "modified": [ + "README.md", + "pnpm-lock.yaml", + "src/examples/github-webhook.ts" + ], + "committer": { + "name": "Eric Allam", + "email": "eallam@icloud.com", + "username": "ericallam" + }, + "timestamp": "2023-01-24T04:43:40Z" + }, + "organization": { + "id": 95297378, + "url": "https://api.github.com/orgs/triggerdotdev", + "login": "triggerdotdev", + "node_id": "O_kgDOBa4fYg", + "hooks_url": "https://api.github.com/orgs/triggerdotdev/hooks", + "repos_url": "https://api.github.com/orgs/triggerdotdev/repos", + "avatar_url": "https://avatars.githubusercontent.com/u/95297378?v=4", + "events_url": "https://api.github.com/orgs/triggerdotdev/events", + "issues_url": "https://api.github.com/orgs/triggerdotdev/issues", + "description": "", + "members_url": "https://api.github.com/orgs/triggerdotdev/members{/member}", + "public_members_url": "https://api.github.com/orgs/triggerdotdev/public_members{/member}" + } +} +``` diff --git a/apps/docs/integrations/apis/resend/actions/send-email.mdx b/apps/docs/integrations/apis/resend/actions/send-email.mdx new file mode 100644 index 00000000000..1ab79e7c8b8 --- /dev/null +++ b/apps/docs/integrations/apis/resend/actions/send-email.mdx @@ -0,0 +1,127 @@ +--- +title: "Send Email" +sidebarTitle: "Send Email" +description: "Send email using Resend.com" +--- + +Send email using Resend.com, which supports sending emails using React, HTML, and plain text. Resend.com is currently in private beta but you can request early access [here](https://resend.com/). + + + If you'd like to render emails using React, please see the [React.email + docs](https://react.email/) + + +## Params + + + A unique string. Please see the [Keys and Resumability](/guides/resumability) + doc for more info. + + + + + + The text of the email. If `html` is provided, this will be used as the + plain text version of the email. + + + + The HTML of the email. If `text` is provided, this will be used as the + HTML version of the email. + + + + A React component that will be rendered to HTML and used as the email + content. Please see the [React.email docs](https://react.email/) for more info + + + + The subject of the email. + + + + The email address of the sender. + + + + One or more email addresses of the recipients. + + + + One or more email addresses of the CC recipients. + + + + One or more email addresses of the BCC recipients. + + + + An optional email address to use as the reply-to address. + + + + + +## Response + + + The ID of the email. + + + + The email address of the sender. + + + + The email address of the recipient. + + + + The date and time the email was created. + + +## Example Workflows + + + +```typescript criticalIssue.tsx +import { github, resend } from "@trigger.dev/integrations"; +import { CriticalIssueEmail } from "./emails"; + +new Trigger({ + id: "email-ops", + name: "On Critical Issue", + on: github.events.issueEvent({ + repo: "triggerdotdev/trigger.dev", + }), + run: async (event, ctx) => { + if (event.action === "labeled" && event.label.name === "critical") { + await resend.sendEmail("🚨 Alert Ops", { + to: "ops@trigger.dev", + from: "internal@trigger.dev", + subject: `Critical issue: ${event.issue.title}`, + react: ( + + ), + }); + } + }, +}).listen(); +``` + + + +## Example Response + +```json +{ + "id": "1673618429", + "from": "internal@trigger.dev", + "to": "ops@trigger.dev", + "created_at": "2023-01-24T14:38:26Z" +} +``` diff --git a/apps/docs/mint.json b/apps/docs/mint.json index 6e7db9164f4..16669e28583 100644 --- a/apps/docs/mint.json +++ b/apps/docs/mint.json @@ -3,7 +3,7 @@ "logo": { "dark": "/logo/light.png", "light": "/logo/light.png", - "href": "https://app.trigger.dev" + "href": "https://trigger.dev" }, "favicon": "/images/favicon.png", "colors": { @@ -15,25 +15,43 @@ "to": "#0fd122" } }, + "backgroundImage": "/images/docs-background.png", "modeToggle": { "default": "dark", "isHidden": true }, - "topbarLinks": [ + "topbarCtaButton": { + "type": "github", + "url": "https://github.com/triggerdotdev/trigger.dev" + }, + "anchors": [ + { + "name": "Community", + "icon": "discord", + "url": "https://discord.gg/nkqV9xBYWy" + }, { "name": "GitHub", + "icon": "github", "url": "https://github.com/triggerdotdev/trigger.dev" } ], - "topbarCtaButton": { - "name": "Trigger.dev", - "url": "https://app.trigger.dev" - }, "navigation": [ { "group": "Getting Started", "pages": [ - "getting-started" + "welcome", + "getting-started", + "get-help" + ] + }, + { + "group": "Examples", + "pages": [ + "examples/examples", + "examples/slack", + "examples/github", + "examples/shopify" ] }, { @@ -55,6 +73,12 @@ "pages": [ "integrations/apis/slack/actions/post-message" ] + }, + { + "group": "Resend.com", + "pages": [ + "integrations/apis/resend/actions/send-email" + ] } ] }, @@ -75,7 +99,8 @@ "group": "Guides", "pages": [ "guides/resumability", - "guides/zod" + "guides/zod", + "guides/event-driven" ] }, { @@ -84,23 +109,21 @@ { "group": "GitHub", "pages": [ + "integrations/apis/github/events/push", + "integrations/apis/github/events/issues", + "integrations/apis/github/events/issue-comments", + "integrations/apis/github/events/pull-requests", + "integrations/apis/github/events/pull-request-reviews", + "integrations/apis/github/events/pull-request-comments", "integrations/apis/github/events/new-star" ] } ] - }, - { - "group": "Example workflows", - "pages": [ - "examples/github", - "examples/shopify", - "examples/slack" - ] } ], "footerSocials": { - "website": "https://app.trigger.dev", "twitter": "https://twitter.com/triggerdotdev", - "github": "https://github.com/triggerdotdev/trigger.dev" + "github": "https://github.com/triggerdotdev/trigger.dev", + "discord": "https://discord.gg/nkqV9xBYWy" } } \ No newline at end of file diff --git a/apps/docs/package.json b/apps/docs/package.json index ab20283dd6f..31ae16e9b98 100644 --- a/apps/docs/package.json +++ b/apps/docs/package.json @@ -4,9 +4,9 @@ "description": "Trigger.dev documentation", "private": true, "scripts": { - "dev": "PORT=3050 mintlify dev" + "dev": "mintlify dev --port 3050" }, "devDependencies": { - "mintlify": "^1.3.0" + "mintlify": "^2.0.14" } -} +} \ No newline at end of file diff --git a/apps/docs/triggers/custom-events.mdx b/apps/docs/triggers/custom-events.mdx index 30cd1c25b9a..96b793c9831 100644 --- a/apps/docs/triggers/custom-events.mdx +++ b/apps/docs/triggers/custom-events.mdx @@ -4,27 +4,28 @@ sidebarTitle: "Custom events" description: "Custom event triggers allow you to run workflows from your own code (or your other workflows)" --- -[Send an event](/functions/send-event) and any workflows that subscribe to that Custom event will get triggered. +[Send an event](/functions/send-event) and any workflows that subscribe to that custom event will get triggered. ## Name and Schemas ### Name -Custom event triggers have a `name`. They will only get triggered when a custom even with that name are sent. +Custom event triggers have a `name`. They will only get triggered when a custom event with that name are sent. ### Schema -Custom event triggers have a schema. This is used to validate the data that is sent with the event. If the data does not match the schema, the workflow will not run. +Custom event triggers take a [Zod](https://github.com/colinhacks/zod) schema. This is used to validate the data that is sent with the event. If the data does not match the schema, the workflow will not run. -It also means that inside your run function you will have type safety for the data you receive. We use [Zod](https://github.com/colinhacks/zod#installation) for our schemas – it's a fantastic library that allows you to define schemas in a very simple way. +It also means that inside your run function the event param will be typed correctly. We use [Zod](https://github.com/colinhacks/zod#installation) for our schemas – it's a fantastic library that allows you to define schemas in a very simple way. -You can always start out by using `z.any()` as your schema, and then later on you can add more strict validation. +You can always start out by using `z.any()` as your schema, and then later on you can add more strict validation. See our [Zod guide](/guides/zod) for more information. ## Example ```ts import { Trigger, customEvent } from "@trigger.dev/sdk"; import { slack } from "@trigger.dev/integrations"; +import { z } from "zod"; //this workflow will run when a "user.created" event is sent new Trigger({ diff --git a/apps/docs/welcome.mdx b/apps/docs/welcome.mdx new file mode 100644 index 00000000000..5b7272966a2 --- /dev/null +++ b/apps/docs/welcome.mdx @@ -0,0 +1,48 @@ +--- +title: "Trigger.dev Documentation" +sidebarTitle: "Welcome" +description: "" +--- + + + Trigger.dev is in private beta. We are now inviting users from our waitlist + [here.](https://bcymafitv0e.typeform.com/tddsignup?typeform-source=trigger.dev#source=Docs) + + +Trigger.dev is an open source platform that enables developers to create event-driven background tasks directly in their code. Build, test and run workflows locally and subscribe to webhooks, schedule jobs, run background jobs and add long delays easily and reliably. + +Workflows live in your codebase so you can use your existing types, functions, version control and IDE. They are triggered by us but run on your server so your private data is never exposed. + +_A workflow in action:_ +![Test a run](/images/workflow-demo.gif) + + + + Quickly get up and running with Trigger.dev by following our quick start + guide. + + + One of the quickest ways to learn how Trigger.dev works is to view some + example workflows. + + + The #help-and-questions channel is a great place to get help with any + questions about Trigger.dev. + + + Arrange a call with one of the founders. We can help answer questions, build + API integrations for you and help you with workflows. + + diff --git a/apps/webapp/app/assets/images/discord.png b/apps/webapp/app/assets/images/discord.png new file mode 100644 index 00000000000..f728120e659 Binary files /dev/null and b/apps/webapp/app/assets/images/discord.png differ diff --git a/apps/webapp/app/assets/images/onboarding-image.png b/apps/webapp/app/assets/images/onboarding-image.png index 40406c0cf74..04337710b0d 100644 Binary files a/apps/webapp/app/assets/images/onboarding-image.png and b/apps/webapp/app/assets/images/onboarding-image.png differ diff --git a/apps/webapp/app/components/CreateNewWorkflow.tsx b/apps/webapp/app/components/CreateNewWorkflow.tsx index 4c07c1e2bf5..92961e3930b 100644 --- a/apps/webapp/app/components/CreateNewWorkflow.tsx +++ b/apps/webapp/app/components/CreateNewWorkflow.tsx @@ -3,9 +3,10 @@ import { Panel } from "./layout/Panel"; import { PrimaryA, SecondaryA } from "./primitives/Buttons"; import { Body } from "./primitives/text/Body"; import { SubTitle } from "./primitives/text/SubTitle"; -import onboarding from "../assets/images/onboarding-image.png"; import { ApiLogoIcon } from "~/components/code/ApiLogoIcon"; import { getProviders } from "@trigger.dev/providers"; +import onboarding from "../assets/images/onboarding-image.png"; +import discord from "../assets/images/discord.png"; export default function CreateNewWorkflow() { return ( @@ -42,13 +43,10 @@ export function CreateNewWorkflowNoWorkflows() { Trigger.dev workflows are written in your own codebase and run in your existing infrastructure. - + To get started -
    +
    1. Check out the Quick Start Guide to create your first workflow in your code. @@ -80,10 +78,7 @@ export function CreateNewWorkflowNoWorkflows() { Example workflows - + API integrations @@ -97,7 +92,7 @@ export function CreateNewWorkflowNoWorkflows() { {" "} and we'll add it. -
      +
      {getProviders(false).map((provider) => (
      + + Join the community + + + To get help quickly and answers to any questions, join our Discord. + + + Discord + Join Discord +
      Create a new Workflow
      @@ -125,3 +134,5 @@ export function CreateNewWorkflowNoWorkflows() { ); } + +const allCapsTitleClasses = "mb-2 uppercase tracking-wide text-slate-400"; diff --git a/apps/webapp/app/components/layout/Footer.tsx b/apps/webapp/app/components/layout/Footer.tsx index acfd9079e4b..59fdc902f47 100644 --- a/apps/webapp/app/components/layout/Footer.tsx +++ b/apps/webapp/app/components/layout/Footer.tsx @@ -22,11 +22,11 @@ export function Footer() {

      -
      - {/* + Discord @@ -38,7 +38,7 @@ export function Footer() { className={linkStyle} > Twitter - */} + Get in touch diff --git a/apps/webapp/app/models/workflowListPresenter.server.ts b/apps/webapp/app/models/workflowListPresenter.server.ts index 96d82fc2b1d..11831225574 100644 --- a/apps/webapp/app/models/workflowListPresenter.server.ts +++ b/apps/webapp/app/models/workflowListPresenter.server.ts @@ -143,7 +143,10 @@ function triggerProperties( ); break; default: - throw new Error(`Unsupported service ${externalSource.service}`); + displayProperties = { + title: externalSource.service, + }; + break; } return { diff --git a/apps/webapp/app/models/workflowRunPresenter.server.ts b/apps/webapp/app/models/workflowRunPresenter.server.ts index f2d56653feb..8fd59581393 100644 --- a/apps/webapp/app/models/workflowRunPresenter.server.ts +++ b/apps/webapp/app/models/workflowRunPresenter.server.ts @@ -10,7 +10,7 @@ import { } from "@trigger.dev/common-schemas"; import type { Provider } from "@trigger.dev/providers"; import type { DisplayProperties } from "internal-integrations"; -import { shopify, slack } from "internal-integrations"; +import { integrations as internalIntegrations } from "internal-integrations"; import invariant from "tiny-invariant"; import type { PrismaClient } from "~/db.server"; import { prisma } from "~/db.server"; @@ -154,23 +154,18 @@ async function parseStep( let displayProperties: DisplayProperties; - switch (externalService.slug) { - case "slack": - displayProperties = slack.requests.displayProperties( - original.integrationRequest.endpoint, - original.integrationRequest.params - ); - break; - case "shopify": - displayProperties = shopify.requests.displayProperties( - original.integrationRequest.endpoint, - original.integrationRequest.params - ); - break; - default: - displayProperties = { - title: "Unknown integration", - }; + const internalIntegration = internalIntegrations[externalService.slug]; + const requests = internalIntegration?.requests; + + if (requests) { + displayProperties = requests.displayProperties( + original.integrationRequest.endpoint, + original.integrationRequest.params + ); + } else { + displayProperties = { + title: "Unknown integration", + }; } return { diff --git a/apps/webapp/app/routes/__app/orgs/$organizationSlug/workflows/$workflowSlug/runs/$runId.tsx b/apps/webapp/app/routes/__app/orgs/$organizationSlug/workflows/$workflowSlug/runs/$runId.tsx index 26a44c2fa80..0b143e9165c 100644 --- a/apps/webapp/app/routes/__app/orgs/$organizationSlug/workflows/$workflowSlug/runs/$runId.tsx +++ b/apps/webapp/app/routes/__app/orgs/$organizationSlug/workflows/$workflowSlug/runs/$runId.tsx @@ -19,6 +19,7 @@ import type { LoaderArgs } from "@remix-run/server-runtime"; import type { Delay, Scheduled } from "@trigger.dev/common-schemas"; import classNames from "classnames"; import humanizeDuration from "humanize-duration"; +import { integrations } from "internal-integrations"; import type { ReactNode } from "react"; import { useEffect, useState } from "react"; import { typedjson, useTypedLoaderData } from "remix-typedjson"; @@ -642,6 +643,12 @@ function IntegrationRequestStep({ const organization = useCurrentOrganization(); invariant(organization, "Organization must be set"); + const internalIntegration = integrations[request.service.slug]; + const component = internalIntegration.requests?.renderComponent( + request.input, + request.output + ); + return ( <> @@ -712,6 +719,17 @@ function IntegrationRequestStep({ ) )}
      + {request.status === "SUCCESS" && component !== null && ( + <> + + Preview + +
      {component}
      + + )} ); } diff --git a/apps/webapp/app/routes/resources/run/$organizationSlug/test/$workflowSlug.ts b/apps/webapp/app/routes/resources/run/$organizationSlug/test/$workflowSlug.ts index 204b2ce7ebe..30cd55775e0 100644 --- a/apps/webapp/app/routes/resources/run/$organizationSlug/test/$workflowSlug.ts +++ b/apps/webapp/app/routes/resources/run/$organizationSlug/test/$workflowSlug.ts @@ -79,6 +79,14 @@ export const action = async ({ request, params }: ActionArgs) => { ); } + if (run === true) { + return redirectWithErrorMessage( + `/orgs/${organizationSlug}/workflows/${workflowSlug}/runs`, + request, + "This run is disabled" + ); + } + return redirectWithSuccessMessage( `/orgs/${organizationSlug}/workflows/${workflowSlug}/runs/${run.id}`, request, diff --git a/apps/webapp/app/services/events/ingest.server.ts b/apps/webapp/app/services/events/ingest.server.ts index b4c3076e2c2..b3ba11f1ccf 100644 --- a/apps/webapp/app/services/events/ingest.server.ts +++ b/apps/webapp/app/services/events/ingest.server.ts @@ -1,4 +1,5 @@ import type { TriggerType } from ".prisma/client"; +import { ulid } from "ulid"; import type { PrismaClient } from "~/db.server"; import { prisma } from "~/db.server"; import type { Organization } from "~/models/organization.server"; @@ -29,10 +30,12 @@ export class IngestEvent { ? await findEnvironmentByApiKey(options.apiKey) : undefined; + const id = options.id ?? ulid(); + // Create a new event in the database const event = await this.#prismaClient.triggerEvent.create({ data: { - id: options.id, + id, organization: { connect: { id: organization.id, diff --git a/apps/webapp/app/services/messageBroker.server.ts b/apps/webapp/app/services/messageBroker.server.ts index 1cdacd57473..189a5ff1476 100644 --- a/apps/webapp/app/services/messageBroker.server.ts +++ b/apps/webapp/app/services/messageBroker.server.ts @@ -1,5 +1,5 @@ +import type { FetchOutputSchema } from "@trigger.dev/common-schemas"; import { - FetchOutputSchema, JsonSchema, ScheduledEventPayloadSchema, } from "@trigger.dev/common-schemas"; @@ -17,11 +17,10 @@ import { ZodPubSub, ZodSubscriber, } from "internal-platform"; -import type { PulsarClient } from "./pulsarClient.server"; -import { createPulsarClient } from "./pulsarClient.server"; import { Topics } from "internal-pulsar"; import { z } from "zod"; import { env } from "~/env.server"; +import { findFetchRequestById } from "~/models/fetchRequest.server"; import { findIntegrationRequestById } from "~/models/integrationRequest.server"; import { completeWorkflowRun, @@ -37,18 +36,19 @@ import { sendEmail } from "./email.server"; import { DispatchEvent } from "./events/dispatch.server"; import { HandleNewServiceConnection } from "./externalServices/handleNewConnection.server"; import { RegisterExternalSource } from "./externalSources/registerExternalSource.server"; +import { CreateFetchRequest } from "./fetches/createFetchRequest.server"; +import { PerformFetchRequest } from "./fetches/performFetchRequest.server"; +import { StartFetchRequest } from "./fetches/startFetchRequest.server"; +import type { PulsarClient } from "./pulsarClient.server"; +import { createPulsarClient } from "./pulsarClient.server"; import { CreateIntegrationRequest } from "./requests/createIntegrationRequest.server"; import { PerformIntegrationRequest } from "./requests/performIntegrationRequest.server"; import { StartIntegrationRequest } from "./requests/startIntegrationRequest.server"; import { WaitForConnection } from "./requests/waitForConnection.server"; import { WorkflowRunDisconnected } from "./runs/runDisconnected.server"; +import { WorkflowRunTriggerTimeout } from "./runs/runTriggerTimeout.server"; import { DeliverScheduledEvent } from "./scheduler/deliverScheduledEvent.server"; import { RegisterSchedulerSource } from "./scheduler/registerSchedulerSource.server"; -import { WorkflowRunTriggerTimeout } from "./runs/runTriggerTimeout.server"; -import { CreateFetchRequest } from "./fetches/createFetchRequest.server"; -import { findFetchRequestById } from "~/models/fetchRequest.server"; -import { StartFetchRequest } from "./fetches/startFetchRequest.server"; -import { PerformFetchRequest } from "./fetches/performFetchRequest.server"; let pulsarClient: PulsarClient; let triggerPublisher: ZodPublisher; diff --git a/apps/webapp/app/services/requests/performIntegrationRequest.server.ts b/apps/webapp/app/services/requests/performIntegrationRequest.server.ts index 213cdfc3ed3..320042e1fd5 100644 --- a/apps/webapp/app/services/requests/performIntegrationRequest.server.ts +++ b/apps/webapp/app/services/requests/performIntegrationRequest.server.ts @@ -4,7 +4,7 @@ import type { NormalizedResponse, PerformedRequestResponse, } from "internal-integrations"; -import { shopify, slack } from "internal-integrations"; +import { resend, shopify, slack } from "internal-integrations"; import type { PrismaClient } from "~/db.server"; import { prisma } from "~/db.server"; import type { IntegrationRequest } from "~/models/integrationRequest.server"; @@ -241,6 +241,14 @@ export class PerformIntegrationRequest { cache, }); } + case "resend": { + return resend.requests.perform({ + accessInfo, + endpoint: integrationRequest.endpoint, + params: integrationRequest.params, + cache, + }); + } default: { throw new Error(`Unknown service: ${service}`); } diff --git a/apps/webapp/public/images/logo-banner.png b/apps/webapp/public/images/logo-banner.png new file mode 100644 index 00000000000..7782a1f4939 Binary files /dev/null and b/apps/webapp/public/images/logo-banner.png differ diff --git a/apps/webapp/public/images/private-beta-banner.png b/apps/webapp/public/images/private-beta-banner.png deleted file mode 100644 index 85879be36e5..00000000000 Binary files a/apps/webapp/public/images/private-beta-banner.png and /dev/null differ diff --git a/apps/webapp/public/integrations/resend.png b/apps/webapp/public/integrations/resend.png new file mode 100644 index 00000000000..22f076838ae Binary files /dev/null and b/apps/webapp/public/integrations/resend.png differ diff --git a/apps/webapp/public/integrations/sendgrid.png b/apps/webapp/public/integrations/sendgrid.png new file mode 100644 index 00000000000..c990c90fdd0 Binary files /dev/null and b/apps/webapp/public/integrations/sendgrid.png differ diff --git a/examples/github-webhook/src/index.ts b/examples/github-webhook/src/index.ts index e5c0145f80d..2d6e3b899be 100644 --- a/examples/github-webhook/src/index.ts +++ b/examples/github-webhook/src/index.ts @@ -17,6 +17,22 @@ new Trigger({ }, }).listen(); +new Trigger({ + id: "github-issue-comment", + name: "GitHub issue comment: triggerdotdev/trigger.dev-examples", + apiKey: "trigger_dev_zC25mKNn6c0q", + endpoint: "ws://localhost:8889/ws", + logLevel: "debug", + on: github.events.issueCommentEvent({ + repo: "triggerdotdev/trigger.dev-examples", + }), + run: async (event, ctx) => { + await ctx.logger.info(`Action was ${event.action}`); + + return {}; + }, +}).listen(); + new Trigger({ id: "github-webhook-pull_request", name: "GitHub PR: triggerdotdev/trigger.dev-examples", diff --git a/examples/resend/package.json b/examples/resend/package.json new file mode 100644 index 00000000000..7fcd115597f --- /dev/null +++ b/examples/resend/package.json @@ -0,0 +1,34 @@ +{ + "private": true, + "name": "@examples/resend", + "version": "0.0.1", + "description": "Send an email using Resend", + "dependencies": { + "@react-email/button": "^0.0.4", + "@react-email/container": "^0.0.4", + "@react-email/head": "^0.0.2", + "@react-email/heading": "^0.0.5", + "@react-email/hr": "^0.0.2", + "@react-email/html": "^0.0.2", + "@react-email/img": "^0.0.2", + "@react-email/link": "^0.0.2", + "@react-email/preview": "^0.0.2", + "@react-email/render": "^0.0.3", + "@react-email/section": "^0.0.1", + "@react-email/text": "^0.0.2", + "@trigger.dev/integrations": "workspace:*", + "@trigger.dev/sdk": "workspace:*", + "react": "^18.2.0", + "zod": "^3.20.2" + }, + "devDependencies": { + "@trigger.dev/tsconfig": "workspace:*", + "@types/node": "16", + "@types/react": "^18.0.21", + "react-email": "^1.6.1", + "tsx": "^3.12.0" + }, + "scripts": { + "dev": "tsx src/index.tsx" + } +} diff --git a/examples/resend/src/index.tsx b/examples/resend/src/index.tsx new file mode 100644 index 00000000000..c783d8b66ce --- /dev/null +++ b/examples/resend/src/index.tsx @@ -0,0 +1,188 @@ +import { Trigger, customEvent } from "@trigger.dev/sdk"; +import { resend } from "@trigger.dev/integrations"; +import { Head } from "@react-email/head"; +import { Html } from "@react-email/html"; +import { Link } from "@react-email/link"; +import { Preview } from "@react-email/preview"; +import { Section } from "@react-email/section"; +import { Text } from "@react-email/text"; +import { Img } from "@react-email/img"; +import * as React from "react"; +import { z } from "zod"; + +new Trigger({ + id: "resend", + name: "Resend text/html", + apiKey: "trigger_development_YpG7UQygbuT3", + endpoint: "ws://localhost:8889/ws", + logLevel: "debug", + on: customEvent({ + name: "send.email", + schema: z.object({ + from: z.string(), + to: z.union([z.string(), z.array(z.string())]), + bcc: z.union([z.string(), z.array(z.string())]).optional(), + cc: z.union([z.string(), z.array(z.string())]).optional(), + replyTo: z.union([z.string(), z.array(z.string())]).optional(), + subject: z.string().optional(), + text: z.string().optional(), + html: z.string().optional(), + }), + }), + run: async (event, ctx) => { + const response = await resend.sendEmail("text-email", { + to: event.to, + from: event.from, + cc: event.cc, + bcc: event.bcc, + replyTo: event.replyTo, + subject: event.subject, + text: event.text, + html: event.html, + }); + + return response; + }, +}).listen(); + +new Trigger({ + id: "resend-react", + name: "Resend React", + apiKey: "trigger_development_YpG7UQygbuT3", + endpoint: "ws://localhost:8889/ws", + logLevel: "debug", + on: customEvent({ + name: "send.email", + schema: z.object({ + from: z.string(), + to: z.union([z.string(), z.array(z.string())]), + bcc: z.union([z.string(), z.array(z.string())]).optional(), + cc: z.union([z.string(), z.array(z.string())]).optional(), + replyTo: z.union([z.string(), z.array(z.string())]).optional(), + subject: z.string().optional(), + name: z.string().optional(), + }), + }), + run: async (event, ctx) => { + const response = await resend.sendEmail("text-email", { + to: event.to, + from: event.from, + cc: event.cc, + bcc: event.bcc, + replyTo: event.replyTo, + subject: event.subject, + react: , + }); + + return response; + }, +}).listen(); + +const main = { + backgroundColor: "#ffffff", +}; + +const bullets = { + color: "#333", + fontFamily: + '-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Helvetica Neue",Ubuntu,sans-serif', + fontSize: "16px", + lineHeight: "24px", + textAlign: "left" as const, + margin: "0", +}; + +const paragraph = { + color: "#333", + fontFamily: + '-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Helvetica Neue",Ubuntu,sans-serif', + fontSize: "16px", + lineHeight: "24px", + textAlign: "left" as const, +}; + +const anchor = { + color: "#2754C5", + fontFamily: + "-apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif", + fontSize: "16px", + textDecoration: "underline", +}; + +export function TestEmail({ name }: { name?: string }) { + return ( + + + You're now ready to create complex workflows in code! +
      + Hey {name ?? "there"}, + + I’m Matt, CEO of{" "} + + Trigger.dev + + . + + + Our goal is to give developers like you the ability to easily create + much more powerful workflows, directly from your codebase. Creating + complex workflows should be the same as creating any other important + part of your product, which is why we created Trigger.dev. + + + + + If you’re ready - you can{" "} + + create a new workflow. + {" "} + + + Otherwise, please feel free to check out: + + + • Our{" "} + + quickstart guide + {" "} + to get you up and running in minutes + + {/* + + • Browse our pre-built{" "} + + workflow templates + {" "} + if you want some inspiration. + */} + + + • Explore our{" "} + + docs + {" "} + for a full overview of the product and it’s features{" "} + + + + •{" "} + + Schedule a call with us + {" "} + about a workflow idea you have. + + + + Feel free to drop me a message if you have any further questions! + + Best, + Matt + CEO, Trigger.dev +
      + + ); +} diff --git a/examples/resend/tsconfig.json b/examples/resend/tsconfig.json new file mode 100644 index 00000000000..5f950c66477 --- /dev/null +++ b/examples/resend/tsconfig.json @@ -0,0 +1,8 @@ +{ + "extends": "@trigger.dev/tsconfig/examples.json", + "include": ["src/**/*.ts", "src/index.tsx"], + "exclude": ["node_modules", "**/*.test.*"], + "compilerOptions": { + "jsx": "react" + } +} diff --git a/examples/smoke-test/src/index.ts b/examples/smoke-test/src/index.ts index 98707bff212..62093a8b1cf 100644 --- a/examples/smoke-test/src/index.ts +++ b/examples/smoke-test/src/index.ts @@ -11,7 +11,7 @@ const trigger = new Trigger({ name: "My workflow", apiKey: "trigger_dev_zC25mKNn6c0q", endpoint: "ws://localhost:8889/ws", - logLevel: "log", + logLevel: "debug", triggerTTL: 60 * 60 * 24, on: customEvent({ name: "user.created", schema: userCreatedEvent }), run: async (event, ctx) => { @@ -35,3 +35,18 @@ const trigger = new Trigger({ }); trigger.listen(); + +new Trigger({ + id: "log-tests", + name: "My logs", + apiKey: "trigger_dev_zC25mKNn6c0q", + endpoint: "ws://localhost:8889/ws", + logLevel: "debug", + on: customEvent({ name: "user.created", schema: z.any() }), + run: async (event, ctx) => { + await ctx.logger.info("It's been 5 minutes since the last run!"); + await ctx.logger.debug("This is a debug log"); + await ctx.logger.warn("This is a warning"); + await ctx.logger.error("This is an error"); + }, +}).listen(); diff --git a/packages/internal-integrations/package.json b/packages/internal-integrations/package.json index c98aee3948e..7bb1c9b8526 100644 --- a/packages/internal-integrations/package.json +++ b/packages/internal-integrations/package.json @@ -6,10 +6,11 @@ "main": "./src/index.ts", "types": "./src/index.ts", "devDependencies": { + "@trigger.dev/providers": "workspace:*", "@trigger.dev/tsconfig": "workspace:*", "@types/debug": "^4.1.7", "@types/node": "16", - "@trigger.dev/providers": "workspace:*", + "@types/react": "^18.0.21", "typescript": "^4.9.4" }, "scripts": {}, @@ -20,6 +21,7 @@ "@urql/core": "^3.1.1", "debug": "^4.3.4", "graphql": "^16.6.0", + "react": "^18.2.0", "urql": "^3.0.3", "zod": "^3.20.2" }, diff --git a/packages/internal-integrations/src/github/index.ts b/packages/internal-integrations/src/github/index.ts index 6053c5b1751..660b09c0d00 100644 --- a/packages/internal-integrations/src/github/index.ts +++ b/packages/internal-integrations/src/github/index.ts @@ -36,6 +36,7 @@ export class GitHubWebhookIntegration implements WebhookIntegration { handleWebhookRequest(options: HandleWebhookOptions) { const deliveryId = options.request.headers["x-github-delivery"]; + const hookId = options.request.headers["x-github-hook-id"]; const signature = options.request.headers["x-hub-signature-256"]; @@ -45,7 +46,7 @@ export class GitHubWebhookIntegration implements WebhookIntegration { }); console.log( - `[${deliveryId}] GitHubWebhookIntegration: Verifying signature ${signature}` + `[delivery=${deliveryId}][hook=${hookId}] GitHubWebhookIntegration: Verifying signature ${signature}` ); if (!githubWebhooks.verify(options.request.body, signature)) { @@ -72,7 +73,7 @@ export class GitHubWebhookIntegration implements WebhookIntegration { return { status: "ok" as const, - data: { id: deliveryId, payload: options.request.body, event, context }, + data: { id: hookId, payload: options.request.body, event, context }, }; } diff --git a/packages/internal-integrations/src/index.ts b/packages/internal-integrations/src/index.ts index 0bca009a745..df909f63a65 100644 --- a/packages/internal-integrations/src/index.ts +++ b/packages/internal-integrations/src/index.ts @@ -1,4 +1,17 @@ +import * as github from "./github"; export * as github from "./github"; +import * as slack from "./slack"; export * as slack from "./slack"; +import * as shopify from "./shopify"; export * as shopify from "./shopify"; +import * as resend from "./resend"; +import { InternalIntegration } from "./types"; +export * as resend from "./resend"; export * from "./types"; + +export const integrations: Record = { + github, + slack, + shopify, + resend, +}; diff --git a/packages/internal-integrations/src/resend/index.tsx b/packages/internal-integrations/src/resend/index.tsx new file mode 100644 index 00000000000..27dbd581d64 --- /dev/null +++ b/packages/internal-integrations/src/resend/index.tsx @@ -0,0 +1,203 @@ +import { HttpEndpoint, HttpService } from "../services"; +import { + DisplayProperties, + CacheService, + PerformedRequestResponse, + PerformRequestOptions, + RequestIntegration, + AccessInfo, +} from "../types"; +import { resend } from "@trigger.dev/providers"; +import debug from "debug"; +import { getAccessToken } from "../accessInfo"; +import { SendEmailBodySchema } from "@trigger.dev/providers/providers/resend/schemas"; +import React from "react"; + +const log = debug("trigger:integrations:resend"); + +class ResendRequestIntegration implements RequestIntegration { + #sendEmailEndpoint = new HttpEndpoint< + typeof resend.schemas.SendEmailResponseSchema, + typeof SendEmailBodySchema + >({ + response: resend.schemas.SendEmailResponseSchema, + method: "POST", + path: "/email", + }); + + constructor(private readonly baseUrl: string = "https://api.resend.com") {} + + perform(options: PerformRequestOptions): Promise { + switch (options.endpoint) { + case "email.send": { + return this.#sendEmail( + options.accessInfo, + options.params, + options.cache + ); + } + default: { + throw new Error(`Unknown endpoint: ${options.endpoint}`); + } + } + } + + displayProperties(endpoint: string, params: any): DisplayProperties { + switch (endpoint) { + case "email.send": { + const parsed = resend.schemas.SendEmailBodySchema.parse(params); + return { + title: `Send email to ${ + typeof parsed.to === "string" ? parsed.to : parsed.to.join(", ") + }`, + properties: [], + }; + } + default: { + throw new Error(`Unknown endpoint: ${endpoint}`); + } + } + } + + renderComponent(input: any, output: any): React.ReactNode { + const parsedInput = resend.schemas.SendEmailBodySchema.parse(input); + return ( +
      +
      +
      +
      +
      +
      +
      +
      +
      +

      + {parsedInput.from} +

      +

      {parsedInput.subject}

      +
      + + + +
      +
      + +
      +
      +
      + {parsedInput.html && ( +
      + )} + {parsedInput.text && ( +
      {parsedInput.text}
      + )} +
      +
      + ); + } + + async #sendEmail( + accessInfo: AccessInfo, + params: any, + cache?: CacheService + ): Promise { + const parsedParams = resend.schemas.SendEmailBodySchema.parse(params); + + log("email.send %O", parsedParams); + + const accessToken = getAccessToken(accessInfo); + + const service = new HttpService({ + accessToken, + baseUrl: this.baseUrl, + }); + + const response = await service.performRequest(this.#sendEmailEndpoint, { + ...parsedParams, + }); + + if (!response.success) { + log("email.send failed %O", response); + + return { + ok: false, + isRetryable: this.#isRetryable(response.statusCode), + response: { + output: {}, + context: { + statusCode: response.statusCode, + headers: response.headers, + }, + }, + }; + } + + if (response.statusCode !== 200) { + log("email.send failed %O", response); + + return { + ok: false, + isRetryable: this.#isRetryable(response.statusCode), + response: { + output: response.data, + context: { + statusCode: response.statusCode, + headers: response.headers, + }, + }, + }; + } + + const performedRequest = { + ok: response.success, + isRetryable: this.#isRetryable(response.statusCode), + response: { + output: response.data, + context: { + statusCode: response.statusCode, + headers: response.headers, + }, + }, + }; + + log("email.send performedRequest %O", performedRequest); + + return performedRequest; + } + + #isRetryable(statusCode: number): boolean { + return ( + statusCode === 408 || + statusCode === 429 || + statusCode === 500 || + statusCode === 502 || + statusCode === 503 || + statusCode === 504 + ); + } +} + +export const requests = new ResendRequestIntegration(); + +function EmailInfo({ + label, + value, +}: { + label: string; + value?: string | string[]; +}) { + if (!value) { + return null; + } + + return ( +
      +

      {label}:

      + {typeof value === "string" ? value : value.join(", ")} +
      + ); +} diff --git a/packages/internal-integrations/src/shopify/index.ts b/packages/internal-integrations/src/shopify/index.ts index 44f8624275e..26272276cd3 100644 --- a/packages/internal-integrations/src/shopify/index.ts +++ b/packages/internal-integrations/src/shopify/index.ts @@ -1,13 +1,13 @@ +import { shopify } from "@trigger.dev/providers"; +import { Client, createClient } from "@urql/core"; import debug from "debug"; +import type { ReactNode } from "react"; import { DisplayProperties, PerformedRequestResponse, PerformRequestOptions, RequestIntegration, } from "../types"; -import { Client, createClient, gql } from "@urql/core"; -import { shopify } from "@trigger.dev/providers"; -import { z } from "zod"; import { addProductsToCollectionQuery, appendProductImagesQuery, @@ -167,6 +167,10 @@ class ShopifyRequestIntegration implements RequestIntegration { } } + renderComponent(input: any, output: any): ReactNode { + return null; + } + async #searchProductVariants( client: Client, params: any diff --git a/packages/internal-integrations/src/slack/index.ts b/packages/internal-integrations/src/slack/index.ts index d6ec78d946b..94cd52d3374 100644 --- a/packages/internal-integrations/src/slack/index.ts +++ b/packages/internal-integrations/src/slack/index.ts @@ -11,6 +11,7 @@ import { slack } from "@trigger.dev/providers"; import debug from "debug"; import { getAccessToken } from "../accessInfo"; import { z } from "zod"; +import type { ReactNode } from "react"; const log = debug("trigger:integrations:slack"); @@ -82,6 +83,10 @@ class SlackRequestIntegration implements RequestIntegration { } } + renderComponent(input: any, output: any): ReactNode { + return null; + } + async #postMessage( accessInfo: AccessInfo, params: any, diff --git a/packages/internal-integrations/src/types.ts b/packages/internal-integrations/src/types.ts index d5af5c56190..40218736881 100644 --- a/packages/internal-integrations/src/types.ts +++ b/packages/internal-integrations/src/types.ts @@ -61,6 +61,7 @@ export interface RequestIntegration { options: PerformRequestOptions ) => Promise; displayProperties: (endpoint: string, params: any) => DisplayProperties; + renderComponent(input: any, output: any): React.ReactNode; } export interface WebhookIntegration { @@ -79,3 +80,8 @@ export interface CacheService { get: (key: string) => Promise; set: (key: string, value: string, ttl?: number) => Promise; } + +export type InternalIntegration = { + requests?: RequestIntegration; + webhooks?: WebhookIntegration; +}; diff --git a/packages/internal-integrations/tsconfig.json b/packages/internal-integrations/tsconfig.json index 0720b8b0e12..6f2f339d950 100644 --- a/packages/internal-integrations/tsconfig.json +++ b/packages/internal-integrations/tsconfig.json @@ -1,7 +1,8 @@ { "extends": "@trigger.dev/tsconfig/node16.json", - "include": ["./src/**/*.ts"], + "include": ["./src/**/*.ts", "./src/**/*.tsx"], "compilerOptions": { + "jsx": "react", "experimentalDecorators": true, "emitDecoratorMetadata": true, "baseUrl": ".", diff --git a/packages/trigger-integrations/CHANGELOG.md b/packages/trigger-integrations/CHANGELOG.md index 09294419fd6..84983fe7746 100644 --- a/packages/trigger-integrations/CHANGELOG.md +++ b/packages/trigger-integrations/CHANGELOG.md @@ -1,5 +1,15 @@ # @trigger.dev/integrations +## 0.1.10 + +### Patch Changes + +- c570f06: Added resend.com integration +- Updated dependencies [39b167e] +- Updated dependencies [c570f06] + - @trigger.dev/sdk@0.2.7 + - @trigger.dev/providers@0.1.6 + ## 0.1.9 ### Patch Changes diff --git a/packages/trigger-integrations/package.json b/packages/trigger-integrations/package.json index 6ef233e657e..f350e2ad9f5 100644 --- a/packages/trigger-integrations/package.json +++ b/packages/trigger-integrations/package.json @@ -1,6 +1,6 @@ { "name": "@trigger.dev/integrations", - "version": "0.1.9", + "version": "0.1.10", "description": "trigger.dev integrations", "main": "./dist/index.js", "types": "./dist/index.d.ts", @@ -22,8 +22,9 @@ "build:tsup": "tsup" }, "dependencies": { - "zod": "^3.20.2", + "@react-email/render": "^0.0.3", + "@trigger.dev/providers": "workspace:*", "@trigger.dev/sdk": "workspace:*", - "@trigger.dev/providers": "workspace:*" + "zod": "^3.20.2" } } diff --git a/packages/trigger-integrations/src/index.ts b/packages/trigger-integrations/src/index.ts index ec764e399f4..1d1a1302f29 100644 --- a/packages/trigger-integrations/src/index.ts +++ b/packages/trigger-integrations/src/index.ts @@ -1,5 +1,6 @@ import * as github from "./integrations/github"; +import * as resend from "./integrations/resend"; import * as slack from "./integrations/slack"; import * as shopify from "./integrations/shopify"; -export { github, slack, shopify }; +export { github, resend, slack, shopify }; diff --git a/packages/trigger-integrations/src/integrations/resend/index.ts b/packages/trigger-integrations/src/integrations/resend/index.ts new file mode 100644 index 00000000000..eada14f0a21 --- /dev/null +++ b/packages/trigger-integrations/src/integrations/resend/index.ts @@ -0,0 +1,61 @@ +import { getTriggerRun } from "@trigger.dev/sdk"; +import { z } from "zod"; +import { resend } from "@trigger.dev/providers"; +import { render } from "@react-email/render"; + +export type SendEmailOptions = z.infer< + typeof resend.schemas.SendEmailOptionsSchema +>; + +export type SendEmailResponse = z.infer< + typeof resend.schemas.SendEmailSuccessResponseSchema +>; + +export async function sendEmail( + key: string, + message: SendEmailOptions +): Promise { + const run = getTriggerRun(); + + if (!run) { + throw new Error("Cannot call sendEmail outside of a trigger run"); + } + + //if the supplied email body is react, we need to turn it into html + let html: string | undefined = undefined; + if (message.react) { + html = render(message.react, { + pretty: true, + }); + } else if (message.html) { + html = message.html; + } + + let params: any; + if (html) { + params = { + ...message, + reply_to: message.replyTo, + html, + }; + } else { + params = { + ...message, + reply_to: message.replyTo, + }; + delete params.html; + } + delete params.replyTo; + delete params.react; + + const output = await run.performRequest(key, { + service: "resend", + endpoint: "email.send", + params, + response: { + schema: resend.schemas.SendEmailSuccessResponseSchema, + }, + }); + + return output; +} diff --git a/packages/trigger-providers/CHANGELOG.md b/packages/trigger-providers/CHANGELOG.md index e2801285c28..74edd111b5e 100644 --- a/packages/trigger-providers/CHANGELOG.md +++ b/packages/trigger-providers/CHANGELOG.md @@ -1,5 +1,11 @@ # @trigger.dev/providers +## 0.1.6 + +### Patch Changes + +- c570f06: Added resend.com integration + ## 0.1.5 ### Patch Changes diff --git a/packages/trigger-providers/package.json b/packages/trigger-providers/package.json index 60ace3c9650..4d427998fd5 100644 --- a/packages/trigger-providers/package.json +++ b/packages/trigger-providers/package.json @@ -1,6 +1,6 @@ { "name": "@trigger.dev/providers", - "version": "0.1.5", + "version": "0.1.6", "description": "trigger.dev API providers with schemas", "main": "./dist/index.js", "types": "./dist/index.d.ts", @@ -20,9 +20,9 @@ "devDependencies": { "@trigger.dev/tsconfig": "workspace:*", "@types/node": "16", - "typescript": "^4.9.4", "rimraf": "^3.0.2", - "tsup": "^6.5.0" + "tsup": "^6.5.0", + "typescript": "^4.9.4" }, "scripts": { "clean": "rimraf dist", diff --git a/packages/trigger-providers/src/index.ts b/packages/trigger-providers/src/index.ts index e97269c5977..d8430150bdd 100644 --- a/packages/trigger-providers/src/index.ts +++ b/packages/trigger-providers/src/index.ts @@ -1,5 +1,6 @@ import { airtable } from "./providers/airtable"; import { github } from "./providers/github"; +import { resend } from "./providers/resend"; import { shopify } from "./providers/shopify"; import { slack } from "./providers/slack"; import { Provider } from "./types"; @@ -9,10 +10,10 @@ export type { OAuthAuthentication, Provider, } from "./types"; -export { airtable, github, slack, shopify }; +export { airtable, github, resend, slack, shopify }; const providerCatalog = { - providers: { airtable, github, slack, shopify }, + providers: { airtable, github, resend, slack, shopify }, }; export function getProviders(isAdmin: boolean): Provider[] { diff --git a/packages/trigger-providers/src/providers/resend/index.ts b/packages/trigger-providers/src/providers/resend/index.ts new file mode 100644 index 00000000000..0062c01b2d1 --- /dev/null +++ b/packages/trigger-providers/src/providers/resend/index.ts @@ -0,0 +1,18 @@ +import * as schemas from "./schemas"; + +export const resend = { + name: "Resend", + slug: "resend", + icon: "/integrations/resend.png", + enabledFor: "all", + authentication: { + type: "api_key", + header_name: "Authorization", + header_type: "access_token", + documentation: `1. Login to [Resend](https://resend.com) +2. Go to the API Keys page +3. Generate a new API key +4. Paste it into the field below`, + }, + schemas, +}; diff --git a/packages/trigger-providers/src/providers/resend/schemas.ts b/packages/trigger-providers/src/providers/resend/schemas.ts new file mode 100644 index 00000000000..7b8ed1cdf70 --- /dev/null +++ b/packages/trigger-providers/src/providers/resend/schemas.ts @@ -0,0 +1,48 @@ +import { z } from "zod"; + +const SimplifiedReactElementSchema = z.object({ + type: z.any(), + props: z.any(), + key: z.union([z.string(), z.number()]).nullable(), +}); + +export const BaseSendFieldsSchema = z.object({ + from: z.string(), + to: z.union([z.string(), z.array(z.string())]), + bcc: z.union([z.string(), z.array(z.string())]).optional(), + cc: z.union([z.string(), z.array(z.string())]).optional(), + replyTo: z.union([z.string(), z.array(z.string())]).optional(), + subject: z.string().optional(), +}); + +export const SendEmailOptionsSchema = z + .object({ + text: z.string().optional(), + html: z.string().optional(), + react: SimplifiedReactElementSchema.optional(), + }) + .and(BaseSendFieldsSchema); + +export const SendEmailBodySchema = BaseSendFieldsSchema.omit({ + replyTo: true, +}).and( + z.object({ + reply_to: z.string().optional(), + text: z.string().optional(), + html: z.string().optional(), + }) +); + +export const SendEmailSuccessResponseSchema = z.object({ + id: z.string(), + from: z.string(), + to: z.string(), + created_at: z.string().optional(), +}); +export const SendEmailErrorResponseSchema = z.object({ + error: z.object({ code: z.number(), type: z.string(), message: z.string() }), +}); +export const SendEmailResponseSchema = z.union([ + SendEmailSuccessResponseSchema, + SendEmailErrorResponseSchema, +]); diff --git a/packages/trigger-sdk/CHANGELOG.md b/packages/trigger-sdk/CHANGELOG.md index 0b33606c9e0..cd6051c67ba 100644 --- a/packages/trigger-sdk/CHANGELOG.md +++ b/packages/trigger-sdk/CHANGELOG.md @@ -1,5 +1,11 @@ # @trigger.dev/sdk +## 0.2.7 + +### Patch Changes + +- 39b167e: Better handle event parsing errors from Zod + ## 0.2.6 ### Patch Changes diff --git a/packages/trigger-sdk/package.json b/packages/trigger-sdk/package.json index c04c0a3e7a5..b44973134e5 100644 --- a/packages/trigger-sdk/package.json +++ b/packages/trigger-sdk/package.json @@ -1,6 +1,6 @@ { "name": "@trigger.dev/sdk", - "version": "0.2.6", + "version": "0.2.7", "description": "trigger.dev Node.JS SDK", "main": "./dist/index.js", "types": "./dist/index.d.ts", @@ -42,6 +42,7 @@ "ulid": "^2.3.0", "uuid": "^9.0.0", "ws": "^8.11.0", - "zod": "^3.20.2" + "zod": "^3.20.2", + "zod-error": "^1.1.0" } } diff --git a/packages/trigger-sdk/src/client.ts b/packages/trigger-sdk/src/client.ts index 255c87ec880..b126dce12de 100644 --- a/packages/trigger-sdk/src/client.ts +++ b/packages/trigger-sdk/src/client.ts @@ -14,6 +14,13 @@ import { triggerRunLocalStorage } from "./localStorage"; import { ContextLogger } from "./logger"; import { Trigger, TriggerOptions } from "./trigger"; import { TriggerContext, TriggerFetch } from "./types"; +import { generateErrorMessage, ErrorMessageOptions } from "zod-error"; + +const zodErrorMessageOptions: ErrorMessageOptions = { + delimiter: { + error: " 🔥 ", + }, +}; export class TriggerClient { #trigger: Trigger; @@ -292,6 +299,26 @@ export class TriggerClient { TRIGGER_WORKFLOW: async (data) => { this.#logger.debug("Handling TRIGGER_WORKFLOW", data); + const parsedEventData = this.#options.on.schema.safeParse( + data.trigger.input + ); + + if (!parsedEventData.success) { + await serverRPC.send("SEND_WORKFLOW_ERROR", { + runId: data.id, + timestamp: String(highPrecisionTimestamp()), + error: { + name: "Event validation error", + message: generateErrorMessage( + parsedEventData.error.issues, + zodErrorMessageOptions + ), + }, + }); + + return true; + } + const fetchFunction: TriggerFetch = async (key, url, options) => { const result = new Promise((resolve, reject) => { this.#fetchCallbacks.set(messageKey(data.id, key), { @@ -399,7 +426,7 @@ export class TriggerClient { fetch: fetchFunction, }; - const eventData = this.#options.on.schema.parse(data.trigger.input); + const eventData = parsedEventData.data; this.#logger.debug("Parsed event data", eventData); diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 31775fa763a..ba2fc009ae1 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -31,9 +31,9 @@ importers: apps/docs: specifiers: - mintlify: ^1.3.0 + mintlify: ^2.0.14 devDependencies: - mintlify: 1.3.0 + mintlify: 2.0.14 apps/webapp: specifiers: @@ -180,7 +180,7 @@ importers: '@aws-sdk/client-s3': 3.245.0 '@aws-sdk/s3-request-presigner': 3.245.0 '@cfworker/json-schema': 1.12.5 - '@codemirror/autocomplete': 6.4.0_czcfkg2f66rxeiodoti7r2gulu + '@codemirror/autocomplete': 6.4.0_eo6pz6bvsllvatnnwfprpuflde '@codemirror/commands': 6.1.3 '@codemirror/lang-javascript': 6.1.2 '@codemirror/lang-json': 6.0.1 @@ -205,7 +205,7 @@ importers: '@tanstack/react-table': 8.7.6_biqbaboplfbrettd7655fr4n2y '@trigger.dev/common-schemas': link:../../packages/common-schemas '@trigger.dev/providers': link:../../packages/trigger-providers - '@uiw/react-codemirror': 4.19.5_k4ec5g7vuuzzonc3d6xbjnmmle + '@uiw/react-codemirror': 4.19.5_aguurb4bmecpxzejz52amioxne bcryptjs: 2.4.3 classnames: 2.3.2 clsx: 1.2.1 @@ -462,6 +462,53 @@ importers: '@types/node': 16.18.11 tsx: 3.12.2 + examples/resend: + specifiers: + '@react-email/button': ^0.0.4 + '@react-email/container': ^0.0.4 + '@react-email/head': ^0.0.2 + '@react-email/heading': ^0.0.5 + '@react-email/hr': ^0.0.2 + '@react-email/html': ^0.0.2 + '@react-email/img': ^0.0.2 + '@react-email/link': ^0.0.2 + '@react-email/preview': ^0.0.2 + '@react-email/render': ^0.0.3 + '@react-email/section': ^0.0.1 + '@react-email/text': ^0.0.2 + '@trigger.dev/integrations': workspace:* + '@trigger.dev/sdk': workspace:* + '@trigger.dev/tsconfig': workspace:* + '@types/node': '16' + '@types/react': ^18.0.21 + react: ^18.2.0 + react-email: ^1.6.1 + tsx: ^3.12.0 + zod: ^3.20.2 + dependencies: + '@react-email/button': 0.0.4 + '@react-email/container': 0.0.4 + '@react-email/head': 0.0.2 + '@react-email/heading': 0.0.5 + '@react-email/hr': 0.0.2 + '@react-email/html': 0.0.2 + '@react-email/img': 0.0.2 + '@react-email/link': 0.0.2 + '@react-email/preview': 0.0.2 + '@react-email/render': 0.0.3_react@18.2.0 + '@react-email/section': 0.0.1 + '@react-email/text': 0.0.2 + '@trigger.dev/integrations': link:../../packages/trigger-integrations + '@trigger.dev/sdk': link:../../packages/trigger-sdk + react: 18.2.0 + zod: 3.20.2 + devDependencies: + '@trigger.dev/tsconfig': link:../../config-packages/tsconfig + '@types/node': 16.18.11 + '@types/react': 18.0.26 + react-email: 1.6.1_react@18.2.0 + tsx: 3.12.2 + examples/schedule-to-slack: specifiers: '@trigger.dev/integrations': workspace:* @@ -653,9 +700,11 @@ importers: '@trigger.dev/tsconfig': workspace:* '@types/debug': ^4.1.7 '@types/node': '16' + '@types/react': ^18.0.21 '@urql/core': ^3.1.1 debug: ^4.3.4 graphql: ^16.6.0 + react: ^18.2.0 typescript: ^4.9.4 urql: ^3.0.3 zod: ^3.20.2 @@ -666,13 +715,15 @@ importers: '@urql/core': 3.1.1_graphql@16.6.0 debug: 4.3.4 graphql: 16.6.0 - urql: 3.0.3_graphql@16.6.0 + react: 18.2.0 + urql: 3.0.3_onqnqwb3ubg5opvemcqf7c2qhy zod: 3.20.2 devDependencies: '@trigger.dev/providers': link:../trigger-providers '@trigger.dev/tsconfig': link:../../config-packages/tsconfig '@types/debug': 4.1.7 '@types/node': 16.18.11 + '@types/react': 18.0.26 typescript: 4.9.4 packages/internal-platform: @@ -712,6 +763,7 @@ importers: packages/trigger-integrations: specifiers: + '@react-email/render': ^0.0.3 '@trigger.dev/providers': workspace:* '@trigger.dev/sdk': workspace:* '@trigger.dev/tsconfig': workspace:* @@ -720,6 +772,7 @@ importers: tsup: ^6.5.0 zod: ^3.20.2 dependencies: + '@react-email/render': 0.0.3_react@18.2.0 '@trigger.dev/providers': link:../trigger-providers '@trigger.dev/sdk': link:../trigger-sdk zod: 3.20.2 @@ -770,6 +823,7 @@ importers: uuid: ^9.0.0 ws: ^8.11.0 zod: ^3.20.2 + zod-error: ^1.1.0 dependencies: debug: 4.3.4 evt: 2.4.13 @@ -778,6 +832,7 @@ importers: uuid: 9.0.0 ws: 8.12.0 zod: 3.20.2 + zod-error: 1.1.0 devDependencies: '@trigger.dev/common-schemas': link:../common-schemas '@trigger.dev/tsconfig': link:../../config-packages/tsconfig @@ -3416,12 +3471,13 @@ packages: prettier: 2.8.2 dev: false - /@codemirror/autocomplete/6.4.0_czcfkg2f66rxeiodoti7r2gulu: + /@codemirror/autocomplete/6.4.0_eo6pz6bvsllvatnnwfprpuflde: resolution: {integrity: sha512-HLF2PnZAm1s4kGs30EiqKMgD7XsYaQ0XJnMR0rofEWQ5t5D60SfqpDIkIh1ze5tiEbyUWm8+VJ6W1/erVvBMIA==} peerDependencies: '@codemirror/language': ^6.0.0 '@codemirror/state': ^6.0.0 '@codemirror/view': ^6.0.0 + '@lezer/common': ^1.0.0 dependencies: '@codemirror/language': 6.3.2 '@codemirror/state': 6.2.0 @@ -3441,7 +3497,7 @@ packages: /@codemirror/lang-javascript/6.1.2: resolution: {integrity: sha512-OcwLfZXdQ1OHrLiIcKCn7MqZ7nx205CMKlhe+vL88pe2ymhT9+2P+QhwkYGxMICj8TDHyp8HFKVwpiisUT7iEQ==} dependencies: - '@codemirror/autocomplete': 6.4.0_czcfkg2f66rxeiodoti7r2gulu + '@codemirror/autocomplete': 6.4.0_eo6pz6bvsllvatnnwfprpuflde '@codemirror/language': 6.3.2 '@codemirror/lint': 6.1.0 '@codemirror/state': 6.2.0 @@ -3518,7 +3574,6 @@ packages: commander: 9.4.x dependencies: commander: 9.4.1 - dev: false /@cspotcode/source-map-support/0.8.1: resolution: {integrity: sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==} @@ -3615,7 +3670,6 @@ packages: cpu: [arm] os: [android] requiresBuild: true - dev: false optional: true /@esbuild/android-arm64/0.16.3: @@ -3633,7 +3687,6 @@ packages: cpu: [arm64] os: [android] requiresBuild: true - dev: false optional: true /@esbuild/android-x64/0.16.3: @@ -3651,7 +3704,6 @@ packages: cpu: [x64] os: [android] requiresBuild: true - dev: false optional: true /@esbuild/darwin-arm64/0.16.3: @@ -3669,7 +3721,6 @@ packages: cpu: [arm64] os: [darwin] requiresBuild: true - dev: false optional: true /@esbuild/darwin-x64/0.16.3: @@ -3687,7 +3738,6 @@ packages: cpu: [x64] os: [darwin] requiresBuild: true - dev: false optional: true /@esbuild/freebsd-arm64/0.16.3: @@ -3705,7 +3755,6 @@ packages: cpu: [arm64] os: [freebsd] requiresBuild: true - dev: false optional: true /@esbuild/freebsd-x64/0.16.3: @@ -3723,7 +3772,6 @@ packages: cpu: [x64] os: [freebsd] requiresBuild: true - dev: false optional: true /@esbuild/linux-arm/0.16.3: @@ -3741,7 +3789,6 @@ packages: cpu: [arm] os: [linux] requiresBuild: true - dev: false optional: true /@esbuild/linux-arm64/0.16.3: @@ -3759,7 +3806,6 @@ packages: cpu: [arm64] os: [linux] requiresBuild: true - dev: false optional: true /@esbuild/linux-ia32/0.16.3: @@ -3777,7 +3823,6 @@ packages: cpu: [ia32] os: [linux] requiresBuild: true - dev: false optional: true /@esbuild/linux-loong64/0.15.18: @@ -3803,7 +3848,6 @@ packages: cpu: [loong64] os: [linux] requiresBuild: true - dev: false optional: true /@esbuild/linux-mips64el/0.16.3: @@ -3821,7 +3865,6 @@ packages: cpu: [mips64el] os: [linux] requiresBuild: true - dev: false optional: true /@esbuild/linux-ppc64/0.16.3: @@ -3839,7 +3882,6 @@ packages: cpu: [ppc64] os: [linux] requiresBuild: true - dev: false optional: true /@esbuild/linux-riscv64/0.16.3: @@ -3857,7 +3899,6 @@ packages: cpu: [riscv64] os: [linux] requiresBuild: true - dev: false optional: true /@esbuild/linux-s390x/0.16.3: @@ -3875,7 +3916,6 @@ packages: cpu: [s390x] os: [linux] requiresBuild: true - dev: false optional: true /@esbuild/linux-x64/0.16.3: @@ -3893,7 +3933,6 @@ packages: cpu: [x64] os: [linux] requiresBuild: true - dev: false optional: true /@esbuild/netbsd-x64/0.16.3: @@ -3911,7 +3950,6 @@ packages: cpu: [x64] os: [netbsd] requiresBuild: true - dev: false optional: true /@esbuild/openbsd-x64/0.16.3: @@ -3929,7 +3967,6 @@ packages: cpu: [x64] os: [openbsd] requiresBuild: true - dev: false optional: true /@esbuild/sunos-x64/0.16.3: @@ -3947,7 +3984,6 @@ packages: cpu: [x64] os: [sunos] requiresBuild: true - dev: false optional: true /@esbuild/win32-arm64/0.16.3: @@ -3965,7 +4001,6 @@ packages: cpu: [arm64] os: [win32] requiresBuild: true - dev: false optional: true /@esbuild/win32-ia32/0.16.3: @@ -3983,7 +4018,6 @@ packages: cpu: [ia32] os: [win32] requiresBuild: true - dev: false optional: true /@esbuild/win32-x64/0.16.3: @@ -4001,7 +4035,6 @@ packages: cpu: [x64] os: [win32] requiresBuild: true - dev: false optional: true /@eslint/eslintrc/1.4.1: @@ -4256,13 +4289,19 @@ packages: globby: 11.1.0 read-yaml-file: 1.1.0 + /@mintlify/validation/0.1.4: + resolution: {integrity: sha512-O0WCLeFuAeUHeZuHntvZ0Pz5xBJLPoWspJa3teIX+C7IxrpW/I3hKa82CA2NRttmciud/DFWHgY7q1BomoRr9w==} + dependencies: + zod: 3.20.2 + zod-to-json-schema: 3.20.2_zod@3.20.2 + dev: true + /@mrmlnc/readdir-enhanced/2.2.1: resolution: {integrity: sha512-bPHp6Ji8b41szTOcaP63VlnbbO5Ny6dwAATtY6JTjh5N2OLrb5Qk/Th5cRkRQhkWCt+EJsYrNB0MiL+Gpn6e3g==} engines: {node: '>=4'} dependencies: call-me-maybe: 1.0.2 glob-to-regexp: 0.3.0 - dev: false /@mswjs/cookies/0.2.2: resolution: {integrity: sha512-mlN83YSrcFgk7Dm1Mys40DLssI1KdJji2CMKN8eOlBqsTADYzj2+jWzsANsUTFbxDMWPD5e9bfA1RGqBpS3O1g==} @@ -4323,7 +4362,6 @@ packages: /@nodelib/fs.stat/1.1.3: resolution: {integrity: sha512-shAmDyaQC4H92APFoIaVDHCx5bStIocgvbwQyxPRrbUY20V1EYTbSDchWbuwlMG3V17cprZhA6+78JfB+3DTPw==} engines: {node: '>= 6'} - dev: false /@nodelib/fs.stat/2.0.5: resolution: {integrity: sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==} @@ -4407,9 +4445,83 @@ packages: engines: {node: '>=12.0.0'} dev: true + /@octokit/auth-token/3.0.3: + resolution: {integrity: sha512-/aFM2M4HVDBT/jjDBa84sJniv1t9Gm/rLkalaz9htOm+L+8JMj1k9w0CkUdcxNyNxZPlTxKPVko+m1VlM58ZVA==} + engines: {node: '>= 14'} + dependencies: + '@octokit/types': 9.0.0 + dev: true + + /@octokit/core/4.2.0: + resolution: {integrity: sha512-AgvDRUg3COpR82P7PBdGZF/NNqGmtMq2NiPqeSsDIeCfYFOZ9gddqWNQHnFdEUf+YwOj4aZYmJnlPp7OXmDIDg==} + engines: {node: '>= 14'} + dependencies: + '@octokit/auth-token': 3.0.3 + '@octokit/graphql': 5.0.5 + '@octokit/request': 6.2.3 + '@octokit/request-error': 3.0.2 + '@octokit/types': 9.0.0 + before-after-hook: 2.2.3 + universal-user-agent: 6.0.0 + transitivePeerDependencies: + - encoding + dev: true + + /@octokit/endpoint/7.0.4: + resolution: {integrity: sha512-hXJP43VT2IrUxBCNIahta8qawpIzLvCjHLCuDDsdIPbd6+jPwsc3KGl/kdQ37mLd+sdiJm6c9qKI7k5CjE0Z9A==} + engines: {node: '>= 14'} + dependencies: + '@octokit/types': 9.0.0 + is-plain-object: 5.0.0 + universal-user-agent: 6.0.0 + dev: true + + /@octokit/graphql/5.0.5: + resolution: {integrity: sha512-Qwfvh3xdqKtIznjX9lz2D458r7dJPP8l6r4GQkIdWQouZwHQK0mVT88uwiU2bdTU2OtT1uOlKpRciUWldpG0yQ==} + engines: {node: '>= 14'} + dependencies: + '@octokit/request': 6.2.3 + '@octokit/types': 9.0.0 + universal-user-agent: 6.0.0 + transitivePeerDependencies: + - encoding + dev: true + /@octokit/openapi-types/14.0.0: resolution: {integrity: sha512-HNWisMYlR8VCnNurDU6os2ikx0s0VyEjDYHNS/h4cgb8DeOxQ0n72HyinUtdDVxJhFy3FWLGl0DJhfEWk3P5Iw==} - dev: false + + /@octokit/openapi-types/16.0.0: + resolution: {integrity: sha512-JbFWOqTJVLHZSUUoF4FzAZKYtqdxWu9Z5m2QQnOyEa04fOFljvyh7D3GYKbfuaSWisqehImiVIMG4eyJeP5VEA==} + dev: true + + /@octokit/plugin-paginate-rest/6.0.0_@octokit+core@4.2.0: + resolution: {integrity: sha512-Sq5VU1PfT6/JyuXPyt04KZNVsFOSBaYOAq2QRZUwzVlI10KFvcbUo8lR258AAQL1Et60b0WuVik+zOWKLuDZxw==} + engines: {node: '>= 14'} + peerDependencies: + '@octokit/core': '>=4' + dependencies: + '@octokit/core': 4.2.0 + '@octokit/types': 9.0.0 + dev: true + + /@octokit/plugin-request-log/1.0.4_@octokit+core@4.2.0: + resolution: {integrity: sha512-mLUsMkgP7K/cnFEw07kWqXGF5LKrOkD+lhCrKvPHXWDywAwuDUeDwWBpc69XK3pNX0uKiVt8g5z96PJ6z9xCFA==} + peerDependencies: + '@octokit/core': '>=3' + dependencies: + '@octokit/core': 4.2.0 + dev: true + + /@octokit/plugin-rest-endpoint-methods/7.0.1_@octokit+core@4.2.0: + resolution: {integrity: sha512-pnCaLwZBudK5xCdrR823xHGNgqOzRnJ/mpC/76YPpNP7DybdsJtP7mdOwh+wYZxK5jqeQuhu59ogMI4NRlBUvA==} + engines: {node: '>= 14'} + peerDependencies: + '@octokit/core': '>=3' + dependencies: + '@octokit/core': 4.2.0 + '@octokit/types': 9.0.0 + deprecation: 2.3.1 + dev: true /@octokit/request-error/3.0.2: resolution: {integrity: sha512-WMNOFYrSaX8zXWoJg9u/pKgWPo94JXilMLb2VManNOby9EZxrQaBe/QSC4a1TzpAlpxofg2X/jMnCyZgL6y7eg==} @@ -4418,13 +4530,43 @@ packages: '@octokit/types': 8.1.0 deprecation: 2.3.1 once: 1.4.0 - dev: false + + /@octokit/request/6.2.3: + resolution: {integrity: sha512-TNAodj5yNzrrZ/VxP+H5HiYaZep0H3GU0O7PaF+fhDrt8FPrnkei9Aal/txsN/1P7V3CPiThG0tIvpPDYUsyAA==} + engines: {node: '>= 14'} + dependencies: + '@octokit/endpoint': 7.0.4 + '@octokit/request-error': 3.0.2 + '@octokit/types': 9.0.0 + is-plain-object: 5.0.0 + node-fetch: 2.6.7 + universal-user-agent: 6.0.0 + transitivePeerDependencies: + - encoding + dev: true + + /@octokit/rest/19.0.7: + resolution: {integrity: sha512-HRtSfjrWmWVNp2uAkEpQnuGMJsu/+dBr47dRc5QVgsCbnIc1+GFEaoKBWkYG+zjrsHpSqcAElMio+n10c0b5JA==} + engines: {node: '>= 14'} + dependencies: + '@octokit/core': 4.2.0 + '@octokit/plugin-paginate-rest': 6.0.0_@octokit+core@4.2.0 + '@octokit/plugin-request-log': 1.0.4_@octokit+core@4.2.0 + '@octokit/plugin-rest-endpoint-methods': 7.0.1_@octokit+core@4.2.0 + transitivePeerDependencies: + - encoding + dev: true /@octokit/types/8.1.0: resolution: {integrity: sha512-N4nLjzkiWBqVQqljTTsCrbvHGoWdWfcCeZjbHdggw7a9HbJMnxbK8A+UWdqwR4out30JarlSa3eqKyVK0n5aBg==} dependencies: '@octokit/openapi-types': 14.0.0 - dev: false + + /@octokit/types/9.0.0: + resolution: {integrity: sha512-LUewfj94xCMH2rbD5YJ+6AQ4AVjFYTgpp6rboWM5T7N3IsIF65SBEOVcYMGAEzO/kKNiNaW4LoWtoThOhH06gw==} + dependencies: + '@octokit/openapi-types': 16.0.0 + dev: true /@octokit/webhooks-methods/3.0.2: resolution: {integrity: sha512-Vlnv5WBscf07tyAvfDbp7pTkMZUwk7z7VwEF32x6HqI+55QRwBTcT+D7DDjZXtad/1dU9E32x0HmtDlF9VIRaQ==} @@ -4582,7 +4724,6 @@ packages: react-dom: 18.2.0_react@18.2.0 transitivePeerDependencies: - react - dev: false /@react-email/section/0.0.1: resolution: {integrity: sha512-Pb2HcGNhTOtFRJVB+Kq2vTUnd8M+LuZBuHfpUD16ua/m2/mbW5WeXAfSuJ2Tl6qspzvDKLHqVX+o6HBc1qgl2Q==} @@ -4679,7 +4820,7 @@ packages: eslint: 8.31.0 eslint-import-resolver-node: 0.3.6 eslint-import-resolver-typescript: 3.5.3_hnftvkj7qg3s6bbigj4pr6djxy - eslint-plugin-import: 2.27.4_2ac3tknkazjoq5fxmuugu665ny + eslint-plugin-import: 2.27.4_qdjeohovcytra7xto5vgmxssaq eslint-plugin-jest: 26.9.0_ohsifnwenhmxgcp7mend4dnv74 eslint-plugin-jest-dom: 4.0.3_eslint@8.31.0 eslint-plugin-jsx-a11y: 6.7.1_eslint@8.31.0 @@ -4815,7 +4956,6 @@ packages: dependencies: domhandler: 5.0.3 selderee: 0.10.0 - dev: false /@sentry/browser/7.30.0: resolution: {integrity: sha512-9hpaNAqIBDLdnrZ51iWkqenRotqqweE1f2AlHO56nyT/UE+u+GdmAiBrgRNqdFQQM13JtTG/gu4HGOyLWb9HEA==} @@ -5546,7 +5686,6 @@ packages: /@types/normalize-package-data/2.4.1: resolution: {integrity: sha512-Gj7cI7z+98M282Tqmp2K5EIsoouUEzbBJhQQzDE3jSIRk6r9gsz0oUokqIUR4u1R3dMHo0pDHM7sNOHyhulypw==} - dev: false /@types/prismjs/1.26.0: resolution: {integrity: sha512-ZTaqn/qSqUuAq1YwvOFQfVW1AR/oQJlLSZVustdjwI+GZ8kr0MSHBj0tsXPW1EqHubx50gtBEjbPGsdZwQwCjQ==} @@ -5811,17 +5950,18 @@ packages: eslint-visitor-keys: 3.3.0 dev: true - /@uiw/codemirror-extensions-basic-setup/4.19.5_wd2tsis3in55bkaiwnc2c46tom: + /@uiw/codemirror-extensions-basic-setup/4.19.5_tbeldtdcrf45b35pezgkzq2u4e: resolution: {integrity: sha512-1zt7ZPJ01xKkSW/KDy0FZNga0bngN1fC594wCVG7FBi60ehfcAucpooQ+JSPScKXopxcb+ugPKZvVLzr9/OfzA==} peerDependencies: '@codemirror/autocomplete': '>=6.0.0' '@codemirror/commands': '>=6.0.0' '@codemirror/language': '>=6.0.0' + '@codemirror/lint': '>=6.0.0' '@codemirror/search': '>=6.0.0' '@codemirror/state': '>=6.0.0' '@codemirror/view': '>=6.0.0' dependencies: - '@codemirror/autocomplete': 6.4.0_czcfkg2f66rxeiodoti7r2gulu + '@codemirror/autocomplete': 6.4.0_eo6pz6bvsllvatnnwfprpuflde '@codemirror/commands': 6.1.3 '@codemirror/language': 6.3.2 '@codemirror/lint': 6.1.0 @@ -5830,11 +5970,14 @@ packages: '@codemirror/view': 6.7.2 dev: false - /@uiw/react-codemirror/4.19.5_k4ec5g7vuuzzonc3d6xbjnmmle: + /@uiw/react-codemirror/4.19.5_aguurb4bmecpxzejz52amioxne: resolution: {integrity: sha512-ZCHh8d7beXbF8/t7F1+yHht6A9Y6CdKeOkZq4A09lxJEnyTQrj1FMf2zvfaqc7K23KNjkTCtSlbqKKbVDgrWaw==} peerDependencies: + '@babel/runtime': '>=7.11.0' '@codemirror/state': '>=6.0.0' + '@codemirror/theme-one-dark': '>=6.0.0' '@codemirror/view': '>=6.0.0' + codemirror: '>=6.0.0' react: '>=16.8.0' react-dom: '>=16.8.0' dependencies: @@ -5843,13 +5986,14 @@ packages: '@codemirror/state': 6.2.0 '@codemirror/theme-one-dark': 6.1.0 '@codemirror/view': 6.7.2 - '@uiw/codemirror-extensions-basic-setup': 4.19.5_wd2tsis3in55bkaiwnc2c46tom - codemirror: 6.0.1 + '@uiw/codemirror-extensions-basic-setup': 4.19.5_tbeldtdcrf45b35pezgkzq2u4e + codemirror: 6.0.1_@lezer+common@1.0.2 react: 18.2.0 react-dom: 18.2.0_react@18.2.0 transitivePeerDependencies: - '@codemirror/autocomplete' - '@codemirror/language' + - '@codemirror/lint' - '@codemirror/search' dev: false @@ -6204,7 +6348,6 @@ packages: engines: {node: '>=0.10.0'} dependencies: array-uniq: 1.0.3 - dev: false /array-union/2.1.0: resolution: {integrity: sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==} @@ -6213,7 +6356,6 @@ packages: /array-uniq/1.0.3: resolution: {integrity: sha512-MNha4BWQ6JbwhFhj03YK552f7cb3AzoE8SzeljgChvL1dl3IcvggXVz1DilzySZkCja+CXuZbdW7yATchWn8/Q==} engines: {node: '>=0.10.0'} - dev: false /array-unique/0.2.1: resolution: {integrity: sha512-G2n5bG5fSUCpnsXz4+8FUkYsGPkNfLn9YvS66U5qbTIXI2Ynnlo4Bi42bWv+omKUCqz+ejzfClwne0alJWJPhg==} @@ -6261,7 +6403,6 @@ packages: /arrify/2.0.1: resolution: {integrity: sha512-3duEwti880xqi4eAMN8AyR4a0ByT90zoYdLlevfrvU43vb0YZwZVfxOgxWrLXXXpyugL0hNZc9G6BiB5B3nUug==} engines: {node: '>=8'} - dev: false /asap/2.0.6: resolution: {integrity: sha512-BSHWgDSAiKs50o2Re8ppvp3seVHXSRM44cdSsT9FfNEUUZLOGWVCsiWaRPWM1Znn+mqZ1OfVZ3z3DWEzSp7hRA==} @@ -6394,16 +6535,6 @@ packages: - debug dev: false - /axios/1.1.3: - resolution: {integrity: sha512-00tXVRwKx/FZr/IDVFt4C+f9FYairX517WoGCL6dpOntqLkZofjhu43F/Xl44UOpqa+9sLFDrG/XAnFsUYgkDA==} - dependencies: - follow-redirects: 1.15.2 - form-data: 4.0.0 - proxy-from-env: 1.1.0 - transitivePeerDependencies: - - debug - dev: true - /axios/1.2.2: resolution: {integrity: sha512-bz/J4gS2S3I7mpN/YZfGFTqhXTYzRho8Ay38w2otuuDR322KzFIWm/4W2K6gIwvWaws5n+mnb7D1lN9uD+QH6Q==} dependencies: @@ -6412,7 +6543,6 @@ packages: proxy-from-env: 1.1.0 transitivePeerDependencies: - debug - dev: false /axobject-query/3.1.1: resolution: {integrity: sha512-goKlv8DZrK9hUh975fnHzhNIO4jUnFCfv/dszV5VwUGDFjI6vQ2VwoyjYjYNEbBE8AH87TduWP5uyDR1D+Iteg==} @@ -6503,6 +6633,10 @@ packages: resolution: {integrity: sha512-V/Hy/X9Vt7f3BbPJEi8BdVFMByHi+jNXrYkW3huaybV/kQ0KJg0Y6PkEMbn+zeT+i+SiKZ/HMqJGIIt4LZDqNQ==} dev: false + /before-after-hook/2.2.3: + resolution: {integrity: sha512-NzUnlZexiaH/46WDhANlyR2bXRopNg4F/zuSA3OpZnllCUgRaOF2znDioDWrmbNVsuZk6l9pMquQB38cfBZwkQ==} + dev: true + /better-path-resolve/1.0.0: resolution: {integrity: sha512-pbnl5XzGBdrFU/wT4jqmJVPn2B6UHPBOhzMQkY/SPUPB6QtUXtmBHBIwCbXJol93mOpGMnQyP/+BB19q04xj7g==} engines: {node: '>=4'} @@ -6513,7 +6647,6 @@ packages: /big-integer/1.6.51: resolution: {integrity: sha512-GPEid2Y9QU1Exl1rpO9B2IPJGHPSupF5GnVIP0blYvNOMer2bTvSWs1jGOUg04hTmu67nmLsQ9TBo1puaotBHg==} engines: {node: '>=0.6'} - dev: false /big.js/5.2.2: resolution: {integrity: sha512-vyL2OymJxmarO8gxMr0mhChsO9QGwhynfuu4+MHTAW6czfq9humCB7rKpUjDd9YUiDPU4mzpyupFSvOClAwbmQ==} @@ -6528,7 +6661,6 @@ packages: dependencies: buffers: 0.1.1 chainsaw: 0.1.0 - dev: false /bindings/1.5.0: resolution: {integrity: sha512-p2q/t/mhvuOj/UeLlV6566GD/guowlr0hHxClI0W9m7MWYkL1F0hLo+0Aexs9HSPCtR1SXQ0TD3MMKrXZajbiQ==} @@ -6556,7 +6688,6 @@ packages: /bluebird/3.4.7: resolution: {integrity: sha512-iD3898SR7sWVRHbiQv+sHUtHnMvC1o3nW5rAcqnq3uOn07DSAppZYUkIGslDz6gXC7HfunPe7YVBgoEJASPcHA==} - dev: false /bluebird/3.7.2: resolution: {integrity: sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==} @@ -6668,7 +6799,6 @@ packages: /buffer-indexof-polyfill/1.0.2: resolution: {integrity: sha512-I7wzHwA3t1/lwXQh+A5PbNvJxgfo5r3xulgpYDB5zckTu/Z9oUK9biouBKQUjEqzaz3HnAT6TYoovmE+GqSf7A==} engines: {node: '>=0.10'} - dev: false /buffer/5.7.1: resolution: {integrity: sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==} @@ -6686,7 +6816,6 @@ packages: /buffers/0.1.1: resolution: {integrity: sha512-9q/rDEGSb/Qsvv2qvzIzdluL5k7AaJOTrw23z9reQthrbF7is4CtlT0DXyO1oei2DCp4uojjzQ7igaSHp1kAEQ==} engines: {node: '>=0.2.0'} - dev: false /builtins/1.0.3: resolution: {integrity: sha512-uYBjakWipfaO/bXI7E8rq6kpwHRZK5cNYrUv2OzZSI/FvmdMyXJ2tG9dKcjEC5YHmHpUAwsargWIZNWdxb/bnQ==} @@ -6866,6 +6995,10 @@ packages: resolution: {integrity: sha512-4tYFyifaFfGacoiObjJegolkwSU4xQNGbVgUiNYVUxbQ2x2lUsFvY4hVgVzGiIe6WLOPqycWXA40l+PWsxthUw==} dev: true + /ccount/2.0.1: + resolution: {integrity: sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==} + dev: true + /center-align/0.1.3: resolution: {integrity: sha512-Baz3aNe2gd2LP2qk5U+sDk/m4oSuwSDcBfayTCTBoWpfIGO5XFxPmjILQII4NGiZjD6DoDI6kf7gKaxkf7s3VQ==} engines: {node: '>=0.10.0'} @@ -6891,7 +7024,6 @@ packages: resolution: {integrity: sha512-75kWfWt6MEKNC8xYXIdRpDehRYY/tNSgwKaJq+dbbDcxORuVrrQ+SEHoWsniVn9XPYfP4gmdWIeDk/4YNp1rNQ==} dependencies: traverse: 0.3.9 - dev: false /chalk/2.4.2: resolution: {integrity: sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==} @@ -7175,16 +7307,18 @@ packages: engines: {node: '>=0.10.0'} dev: false - /codemirror/6.0.1: + /codemirror/6.0.1_@lezer+common@1.0.2: resolution: {integrity: sha512-J8j+nZ+CdWmIeFIGXEFbFPtpiYacFMDR8GlHK3IyHQJMCaVRfGx9NT+Hxivv1ckLWPvNdZqndbr/7lVhrf/Svg==} dependencies: - '@codemirror/autocomplete': 6.4.0_czcfkg2f66rxeiodoti7r2gulu + '@codemirror/autocomplete': 6.4.0_eo6pz6bvsllvatnnwfprpuflde '@codemirror/commands': 6.1.3 '@codemirror/language': 6.3.2 '@codemirror/lint': 6.1.0 '@codemirror/search': 6.2.3 '@codemirror/state': 6.2.0 '@codemirror/view': 6.7.2 + transitivePeerDependencies: + - '@lezer/common' dev: false /collection-visit/1.0.0: @@ -7247,7 +7381,6 @@ packages: /commander/2.20.3: resolution: {integrity: sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==} - dev: false /commander/4.1.1: resolution: {integrity: sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA==} @@ -7261,7 +7394,6 @@ packages: /commander/9.4.1: resolution: {integrity: sha512-5EEkTNyHNGFPD2H+c/dXXfQZYa/scCKasxWcXJaWnNJ99pnQN9Vnmqow+p+PlFPE63Q6mThaZws1T+HxfpgtPw==} engines: {node: ^12.20.0 || >=14} - dev: false /commander/9.5.0: resolution: {integrity: sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==} @@ -7322,14 +7454,12 @@ packages: extend-shallow: 2.0.1 is-whitespace: 0.3.0 kind-of: 3.2.2 - dev: false /config-chain/1.1.13: resolution: {integrity: sha512-qj+f8APARXHrM0hraqXYb2/bOVSV4PvJQlNZ/DVj0QrmNM2q2euizkeuVckQ57J+W0mRH6Hvi+k50M4Jul2VRQ==} dependencies: ini: 1.3.8 proto-list: 1.2.4 - dev: false /console-control-strings/1.1.0: resolution: {integrity: sha512-ty/fTekppD2fIwRvnZAVdeOiGd1c7YXEixbgJTNzqcxJWKQnjJ/V1bNEEE6hygpM3WjwHFUVK6HTjWSzV4a8sQ==} @@ -7400,7 +7530,6 @@ packages: make-dir: 3.1.0 nested-error-stacks: 2.1.1 p-event: 4.2.0 - dev: false /cpy/8.1.2: resolution: {integrity: sha512-dmC4mUesv0OYH2kNFEidtf/skUwv4zePmGeepjyyJ0qTo5+8KhA1o99oIAwVVLzQMAeDJml74d6wPPKb6EZUTg==} @@ -7417,7 +7546,6 @@ packages: p-map: 3.0.0 transitivePeerDependencies: - supports-color - dev: false /create-require/1.1.1: resolution: {integrity: sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==} @@ -7781,7 +7909,6 @@ packages: /deepmerge/4.2.2: resolution: {integrity: sha512-FJ3UgI4gIl+PHZm53knsuSFpE+nESMr7M4v9QcgB7S63Kj/6WqMiFQJpBBYz1Pt+66bZpP3Q7Lye0Oo9MPKEdg==} engines: {node: '>=0.10.0'} - dev: false /defaults/1.0.4: resolution: {integrity: sha512-eFuaLoy/Rxalv2kr+lqMlUnrDWV+3j4pljOIJgLIhI058IQfWJ7vXhyEIHu+HtC738klGALYxOKDO0bQP3tg8A==} @@ -7860,7 +7987,6 @@ packages: /deprecation/2.3.1: resolution: {integrity: sha512-xmHIy4F3scKVwMsQ4WnVaS8bHOx0DmVwRywosKhaILI0ywMDWPtBSku2HNxRvF7jtwDRsoEwYQSfbxj8b7RlJQ==} - dev: false /dequal/2.0.3: resolution: {integrity: sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==} @@ -7894,7 +8020,6 @@ packages: engines: {node: '>=12'} dependencies: execa: 5.1.1 - dev: false /detective/5.2.1: resolution: {integrity: sha512-v9XE1zRnz1wRtgurGu0Bs8uHKFSTdteYZNbIPFVhUZ39L/S79ppMpdmVOZAnoz1jfEFodc48n6MX483Xo3t1yw==} @@ -7932,7 +8057,6 @@ packages: engines: {node: '>=4'} dependencies: path-type: 3.0.0 - dev: false /dir-glob/3.0.1: resolution: {integrity: sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==} @@ -8028,7 +8152,6 @@ packages: resolution: {integrity: sha512-asLFVfWWtJ90ZyOUHMqk7/S2w2guQKxUI2itj3d92ADHhxUSbCMGi1f1cBcJ7xM1To+pE/Khbwo1yuNbMEPKeA==} dependencies: readable-stream: 2.3.7 - dev: false /duplexer3/0.1.5: resolution: {integrity: sha512-1A8za6ws41LQgv9HrE/66jyC5yuSjQ3L/KOpFtoBilsAK2iA2wuS5rTt1OCzIvtS2V7nVmedsUU+DGRcjBmOYA==} @@ -8062,7 +8185,6 @@ packages: lru-cache: 4.1.5 semver: 5.7.1 sigmund: 1.0.1 - dev: false /ee-first/1.1.1: resolution: {integrity: sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==} @@ -8447,7 +8569,6 @@ packages: '@esbuild/win32-arm64': 0.16.4 '@esbuild/win32-ia32': 0.16.4 '@esbuild/win32-x64': 0.16.4 - dev: false /escalade/3.1.1: resolution: {integrity: sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==} @@ -8503,7 +8624,7 @@ packages: eslint: 8.31.0 eslint-import-resolver-node: 0.3.7 eslint-import-resolver-typescript: 2.7.1_hnftvkj7qg3s6bbigj4pr6djxy - eslint-plugin-import: 2.27.4_2es4x7ly2gmvaoztzzbbx3tgsy + eslint-plugin-import: 2.27.4_eslint@8.31.0 eslint-plugin-jsx-a11y: 6.7.1_eslint@8.31.0 eslint-plugin-react: 7.31.8_eslint@8.31.0 eslint-plugin-react-hooks: 4.6.0_eslint@8.31.0 @@ -8559,7 +8680,7 @@ packages: dependencies: debug: 4.3.4 eslint: 8.31.0 - eslint-plugin-import: 2.27.4_2es4x7ly2gmvaoztzzbbx3tgsy + eslint-plugin-import: 2.27.4_eslint@8.31.0 glob: 7.2.3 is-glob: 4.0.3 resolve: 1.22.1 @@ -8578,7 +8699,7 @@ packages: debug: 4.3.4 enhanced-resolve: 5.12.0 eslint: 8.31.0 - eslint-plugin-import: 2.27.4_2ac3tknkazjoq5fxmuugu665ny + eslint-plugin-import: 2.27.4_qdjeohovcytra7xto5vgmxssaq get-tsconfig: 4.3.0 globby: 13.1.3 is-core-module: 2.11.0 @@ -8588,7 +8709,7 @@ packages: - supports-color dev: true - /eslint-module-utils/2.7.4_co4ldsxivxjwelu6vt6qmibemq: + /eslint-module-utils/2.7.4_py7h5widiydke2tta7oabbx7ru: resolution: {integrity: sha512-j4GT+rqzCoRKHwURX7pddtIPGySnX9Si/cgMI5ztrcqOPtk5dDEeZ34CQVPphnqkJytlc97Vuk05Um2mJ3gEQA==} engines: {node: '>=4'} peerDependencies: @@ -8609,16 +8730,14 @@ packages: eslint-import-resolver-webpack: optional: true dependencies: - '@typescript-eslint/parser': 5.48.1_iukboom6ndih5an6iafl45j2fe debug: 3.2.7 eslint: 8.31.0 eslint-import-resolver-node: 0.3.7 - eslint-import-resolver-typescript: 2.7.1_hnftvkj7qg3s6bbigj4pr6djxy transitivePeerDependencies: - supports-color dev: true - /eslint-module-utils/2.7.4_v73lhamtbyinynmwa5fn7kpmfq: + /eslint-module-utils/2.7.4_sqt5xxn4ciiurbqrzlaarm6ama: resolution: {integrity: sha512-j4GT+rqzCoRKHwURX7pddtIPGySnX9Si/cgMI5ztrcqOPtk5dDEeZ34CQVPphnqkJytlc97Vuk05Um2mJ3gEQA==} engines: {node: '>=4'} peerDependencies: @@ -8643,7 +8762,6 @@ packages: debug: 3.2.7 eslint: 8.31.0 eslint-import-resolver-node: 0.3.7 - eslint-import-resolver-typescript: 3.5.3_hnftvkj7qg3s6bbigj4pr6djxy transitivePeerDependencies: - supports-color dev: true @@ -8668,7 +8786,7 @@ packages: regexpp: 3.2.0 dev: true - /eslint-plugin-import/2.27.4_2ac3tknkazjoq5fxmuugu665ny: + /eslint-plugin-import/2.27.4_eslint@8.31.0: resolution: {integrity: sha512-Z1jVt1EGKia1X9CnBCkpAOhWy8FgQ7OmJ/IblEkT82yrFU/xJaxwujaTzLWqigewwynRQ9mmHfX9MtAfhxm0sA==} engines: {node: '>=4'} peerDependencies: @@ -8678,7 +8796,6 @@ packages: '@typescript-eslint/parser': optional: true dependencies: - '@typescript-eslint/parser': 5.48.1_iukboom6ndih5an6iafl45j2fe array-includes: 3.1.6 array.prototype.flat: 1.3.1 array.prototype.flatmap: 1.3.1 @@ -8686,7 +8803,7 @@ packages: doctrine: 2.1.0 eslint: 8.31.0 eslint-import-resolver-node: 0.3.7 - eslint-module-utils: 2.7.4_v73lhamtbyinynmwa5fn7kpmfq + eslint-module-utils: 2.7.4_py7h5widiydke2tta7oabbx7ru has: 1.0.3 is-core-module: 2.11.0 is-glob: 4.0.3 @@ -8701,7 +8818,7 @@ packages: - supports-color dev: true - /eslint-plugin-import/2.27.4_2es4x7ly2gmvaoztzzbbx3tgsy: + /eslint-plugin-import/2.27.4_qdjeohovcytra7xto5vgmxssaq: resolution: {integrity: sha512-Z1jVt1EGKia1X9CnBCkpAOhWy8FgQ7OmJ/IblEkT82yrFU/xJaxwujaTzLWqigewwynRQ9mmHfX9MtAfhxm0sA==} engines: {node: '>=4'} peerDependencies: @@ -8719,7 +8836,7 @@ packages: doctrine: 2.1.0 eslint: 8.31.0 eslint-import-resolver-node: 0.3.7 - eslint-module-utils: 2.7.4_co4ldsxivxjwelu6vt6qmibemq + eslint-module-utils: 2.7.4_sqt5xxn4ciiurbqrzlaarm6ama has: 1.0.3 is-core-module: 2.11.0 is-glob: 4.0.3 @@ -9322,7 +9439,6 @@ packages: requiresBuild: true dependencies: unzipper: 0.10.11 - dev: false /fast-glob/2.2.7: resolution: {integrity: sha512-g1KuQwHOZAmOZMuBtHdxDtju+T2RT8jgCC9aANsbpdiDDTSnjgfuVsIBNKbUeJI3oKMRExcfNDtJl4OhbffMsw==} @@ -9336,7 +9452,6 @@ packages: micromatch: 3.1.10 transitivePeerDependencies: - supports-color - dev: false /fast-glob/3.2.11: resolution: {integrity: sha512-xrO3+1bxSo3ZVHAnqzyuewYT6aMFHRAd4Kcs92MAonjwQZLsK9d0SF1IyQ3k5PoirxTW0Oe/RqFgMQ6TcNE5Ew==} @@ -9690,7 +9805,6 @@ packages: inherits: 2.0.4 mkdirp: 0.5.6 rimraf: 2.7.1 - dev: false /ftp/0.3.10: resolution: {integrity: sha512-faFVML1aBx2UoDStmLwv2Wptt4vw5x03xxX172nhA5Y5HBshW5JweqQ2W4xL4dezQTG8inJsuYcpPHHU3X5OTQ==} @@ -9848,7 +9962,6 @@ packages: dependencies: is-glob: 3.1.0 path-dirname: 1.0.2 - dev: false /glob-parent/5.1.2: resolution: {integrity: sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==} @@ -9868,7 +9981,6 @@ packages: /glob-to-regexp/0.3.0: resolution: {integrity: sha512-Iozmtbqv0noj0uDDqoL0zNq0VBEfK2YFoMAZoxJe4cwphvLR+JskfF30QhXHOR4m3KrE6NLRYw+U9MRXvifyig==} - dev: false /glob/7.1.6: resolution: {integrity: sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA==} @@ -9991,7 +10103,6 @@ packages: slash: 2.0.0 transitivePeerDependencies: - supports-color - dev: false /globrex/0.1.2: resolution: {integrity: sha512-uHJgbwAMwNFf5mLst7IWLNg14x1CkeqglJb/K3doi4dw6q2IvAAmM/Y81kevy83wP+Sst+nutFTYOGg3d1lsxg==} @@ -10113,7 +10224,6 @@ packages: engines: {node: '>=0.10.0'} dependencies: is-glob: 3.1.0 - dev: false /has-property-descriptors/1.0.0: resolution: {integrity: sha512-62DVLZGoiEBDHQyqG4w9xCuZ7eJEwNmJRWw2VY84Oedb7WFcA27fiEVe8oUQx9hAUJ4ekurquucTGwsyO1XGdQ==} @@ -10232,7 +10342,6 @@ packages: dom-serializer: 2.0.0 htmlparser2: 8.0.1 selderee: 0.10.0 - dev: false /htmlparser2/3.10.1: resolution: {integrity: sha512-IgieNijUMbkDovyoKObU1DUhm1iwNYE/fuifEoEHfd1oZKZDaONBSkal7Y01shxsM49R4XaMdGez3WnF9UfiCQ==} @@ -10252,7 +10361,6 @@ packages: domhandler: 5.0.3 domutils: 3.0.1 entities: 4.4.0 - dev: false /http-basic/8.1.3: resolution: {integrity: sha512-/EcDMwJZh3mABI2NhGfHOGOeOZITqfkEO4p/xK+l3NpyncIHUQBoMvCSF/b5GqvKtySC2srL/GGG3+EtlqlmCw==} @@ -10365,7 +10473,6 @@ packages: /ignore/4.0.6: resolution: {integrity: sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==} engines: {node: '>= 4'} - dev: false /ignore/5.2.4: resolution: {integrity: sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ==} @@ -10510,6 +10617,11 @@ packages: resolution: {integrity: sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g==} engines: {node: '>= 0.10'} + /is-absolute-url/4.0.1: + resolution: {integrity: sha512-/51/TKE88Lmm7Gc4/8btclNXWS+g50wXhYJq8HWIBAGUBnoAdRu1aXeh364t/O7wXDAcTJDP8PNuNKWUDWie+A==} + engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} + dev: true + /is-accessor-descriptor/0.1.6: resolution: {integrity: sha512-e1BM1qnDbMRG3ll2U9dSK0UMHuWOs3pY3AtcFsmvwPtKL3MML/Q86i+GilLfvqEs4GW+ExB91tQ3Ig9noDIZ+A==} engines: {node: '>=0.10.0'} @@ -10679,7 +10791,6 @@ packages: engines: {node: '>=0.10.0'} dependencies: is-extglob: 2.1.1 - dev: false /is-glob/4.0.3: resolution: {integrity: sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==} @@ -10792,6 +10903,11 @@ packages: dependencies: isobject: 3.0.1 + /is-plain-object/5.0.0: + resolution: {integrity: sha512-VRSzKkbMm5jMDoKLbltAkFQ5Qr7VDiTFGXxYFXXowVj387GeGNOCsOH6Msy00SGZ3Fp84b1Naa1psqgcCIEP5Q==} + engines: {node: '>=0.10.0'} + dev: true + /is-reference/3.0.1: resolution: {integrity: sha512-baJJdQLiYaJdvFbJqXrcGv3WU3QCzBlUcI5QhbesIm6/xPsvmO+2CDoi/GMOFBQEQm+PXkwOPrp9KK5ozZsp2w==} dependencies: @@ -10879,7 +10995,6 @@ packages: /is-whitespace/0.3.0: resolution: {integrity: sha512-RydPhl4S6JwAyj0JJjshWJEFG6hNye3pZFBRZaTUfZFwGHxzppNaNOVgQuS/E/SlhrApuMXrpnK1EEIXfdo3Dg==} engines: {node: '>=0.10.0'} - dev: false /is-windows/1.0.2: resolution: {integrity: sha512-eXK1UInq2bPmjyX6e3VHIzMLobc4J94i4AWn+Hpq3OU5KkrRC96OAcR3PRJ/pGu6m8TRnBHP9dkXQVsT/COVIA==} @@ -11044,7 +11159,6 @@ packages: editorconfig: 0.15.3 glob: 8.0.3 nopt: 6.0.0 - dev: false /js-levenshtein/1.1.6: resolution: {integrity: sha512-X2BB11YZtrRqY4EnQcLX5Rh373zbK4alC1FW7D7MBhL2gtcC17cTnr6DmfHZeS0s2rTHjUTMMHfG7gO8SSdw+g==} @@ -11221,7 +11335,6 @@ packages: /junk/3.1.0: resolution: {integrity: sha512-pBxcB3LFc8QVgdggvZWyeys+hnrNWg4OcZIU/1X59k5jQdLBlCsYGRQaz234SqoRLTCgMH00fY0xRJH+F9METQ==} engines: {node: '>=8'} - dev: false /keyv/3.1.0: resolution: {integrity: sha512-9ykJ/46SN/9KPM/sichzQ7OvXyGDYKGTaDlKMGCAlg2UK8KRy4jb0d8sFc+0Tt0YYnThq8X2RZgCg74RPxgcVA==} @@ -11287,7 +11400,6 @@ packages: /leac/0.6.0: resolution: {integrity: sha512-y+SqErxb8h7nE/fiEX07jsbuhrpO9lL8eca7/Y1nuWV2moNlXhyd59iDGcRf6moVyDMbmTNzL40SUyrFU/yDpg==} - dev: false /levn/0.3.0: resolution: {integrity: sha512-0OO4y2iOHix2W6ujICbKIaEQXvFQHue65vUG3pb5EUomzPI90z9hsA1VsO/dbIIpC53J8gxM9Q4Oho0jrCM/yA==} @@ -11320,7 +11432,6 @@ packages: /listenercount/1.0.1: resolution: {integrity: sha512-3mk/Zag0+IJxeDrxSgaDPy4zZ3w05PRZeJNnlWhzFz5OkX49J4krc+A8X2d2M69vGMBEX0uyl8M+W+8gH+kBqQ==} - dev: false /listr2/3.14.0_enquirer@2.3.6: resolution: {integrity: sha512-TyWI8G99GX9GjE54cJ+RrNMcIFBfwMPxc3XTFiAYGN4s10hWROGtOg7+O6u6LE3mNkyld7RSLE6nrKBvTfcs3g==} @@ -11653,6 +11764,10 @@ packages: engines: {node: '>=0.10.0'} dev: true + /markdown-table/3.0.3: + resolution: {integrity: sha512-Z1NL3Tb1M9wH4XESsCDEksWoKTdlUafKc4pt0GRwjUyXaCFZ+dc3g2erqB6zm3szA2IUSi7VnPI+o/9jnxh9hw==} + dev: true + /marked/4.2.5: resolution: {integrity: sha512-jPueVhumq7idETHkb203WDD4fMA3yV9emQ5vLwop58lu8bTclMghBWcYAavlDqIEMaisADinV1TooIFCfqOsYQ==} engines: {node: '>= 12'} @@ -11674,6 +11789,14 @@ packages: unist-util-visit: 4.1.1 dev: true + /mdast-util-find-and-replace/2.2.1: + resolution: {integrity: sha512-SobxkQXFAdd4b5WmEakmkVoh18icjQRxGy5OWTCzgsLRm1Fu/KCtwD1HIQSsmq5ZRjVH0Ehwg6/Fn3xIUk+nKw==} + dependencies: + escape-string-regexp: 5.0.0 + unist-util-is: 5.1.1 + unist-util-visit-parents: 5.1.1 + dev: true + /mdast-util-from-markdown/1.2.0: resolution: {integrity: sha512-iZJyyvKD1+K7QX1b5jXdE7Sc5dtoTry1vzV28UZZe8Z1xVnB/czKntJ7ZAkG0tANqRnBF6p3p7GpU1y19DTf2Q==} dependencies: @@ -11699,6 +11822,62 @@ packages: micromark-extension-frontmatter: 1.0.0 dev: true + /mdast-util-gfm-autolink-literal/1.0.2: + resolution: {integrity: sha512-FzopkOd4xTTBeGXhXSBU0OCDDh5lUj2rd+HQqG92Ld+jL4lpUfgX2AT2OHAVP9aEeDKp7G92fuooSZcYJA3cRg==} + dependencies: + '@types/mdast': 3.0.10 + ccount: 2.0.1 + mdast-util-find-and-replace: 2.2.1 + micromark-util-character: 1.1.0 + dev: true + + /mdast-util-gfm-footnote/1.0.1: + resolution: {integrity: sha512-p+PrYlkw9DeCRkTVw1duWqPRHX6Ywh2BNKJQcZbCwAuP/59B0Lk9kakuAd7KbQprVO4GzdW8eS5++A9PUSqIyw==} + dependencies: + '@types/mdast': 3.0.10 + mdast-util-to-markdown: 1.5.0 + micromark-util-normalize-identifier: 1.0.0 + dev: true + + /mdast-util-gfm-strikethrough/1.0.2: + resolution: {integrity: sha512-T/4DVHXcujH6jx1yqpcAYYwd+z5lAYMw4Ls6yhTfbMMtCt0PHY4gEfhW9+lKsLBtyhUGKRIzcUA2FATVqnvPDA==} + dependencies: + '@types/mdast': 3.0.10 + mdast-util-to-markdown: 1.5.0 + dev: true + + /mdast-util-gfm-table/1.0.6: + resolution: {integrity: sha512-uHR+fqFq3IvB3Rd4+kzXW8dmpxUhvgCQZep6KdjsLK4O6meK5dYZEayLtIxNus1XO3gfjfcIFe8a7L0HZRGgag==} + dependencies: + '@types/mdast': 3.0.10 + markdown-table: 3.0.3 + mdast-util-from-markdown: 1.2.0 + mdast-util-to-markdown: 1.5.0 + transitivePeerDependencies: + - supports-color + dev: true + + /mdast-util-gfm-task-list-item/1.0.1: + resolution: {integrity: sha512-KZ4KLmPdABXOsfnM6JHUIjxEvcx2ulk656Z/4Balw071/5qgnhz+H1uGtf2zIGnrnvDC8xR4Fj9uKbjAFGNIeA==} + dependencies: + '@types/mdast': 3.0.10 + mdast-util-to-markdown: 1.5.0 + dev: true + + /mdast-util-gfm/2.0.1: + resolution: {integrity: sha512-42yHBbfWIFisaAfV1eixlabbsa6q7vHeSPY+cg+BBjX51M8xhgMacqH9g6TftB/9+YkcI0ooV4ncfrJslzm/RQ==} + dependencies: + mdast-util-from-markdown: 1.2.0 + mdast-util-gfm-autolink-literal: 1.0.2 + mdast-util-gfm-footnote: 1.0.1 + mdast-util-gfm-strikethrough: 1.0.2 + mdast-util-gfm-table: 1.0.6 + mdast-util-gfm-task-list-item: 1.0.1 + mdast-util-to-markdown: 1.5.0 + transitivePeerDependencies: + - supports-color + dev: true + /mdast-util-mdx-expression/1.3.1: resolution: {integrity: sha512-TTb6cKyTA1RD+1su1iStZ5PAv3rFfOUKcoU5EstUpv/IZo63uDX03R8+jXjMEhcobXnNOiG6/ccekvVl4eV1zQ==} dependencies: @@ -11724,6 +11903,21 @@ packages: vfile-message: 3.1.3 dev: true + /mdast-util-mdx-jsx/2.1.0: + resolution: {integrity: sha512-KzgzfWMhdteDkrY4mQtyvTU5bc/W4ppxhe9SzelO6QUUiwLAM+Et2Dnjjprik74a336kHdo0zKm7Tp+n6FFeRg==} + dependencies: + '@types/estree-jsx': 1.0.0 + '@types/hast': 2.3.4 + '@types/mdast': 3.0.10 + ccount: 2.0.1 + mdast-util-to-markdown: 1.5.0 + parse-entities: 4.0.0 + stringify-entities: 4.0.3 + unist-util-remove-position: 4.0.1 + unist-util-stringify-position: 3.0.2 + vfile-message: 3.1.3 + dev: true + /mdast-util-mdx/1.1.0: resolution: {integrity: sha512-leKb9uG7laXdyFlTleYV4ZEaCpsxeU1LlkkR/xp35pgKrfV1Y0fNCuOw9vaRc2a9YDpH22wd145Wt7UY5yzeZw==} dependencies: @@ -11734,6 +11928,16 @@ packages: - supports-color dev: true + /mdast-util-mdx/2.0.0: + resolution: {integrity: sha512-M09lW0CcBT1VrJUaF/PYxemxxHa7SLDHdSn94Q9FhxjCQfuW7nMAWKWimTmA3OyDMSTH981NN1csW1X+HPSluw==} + dependencies: + mdast-util-mdx-expression: 1.3.1 + mdast-util-mdx-jsx: 2.1.0 + mdast-util-mdxjs-esm: 1.3.0 + transitivePeerDependencies: + - supports-color + dev: true + /mdast-util-mdxjs-esm/1.3.0: resolution: {integrity: sha512-7N5ihsOkAEGjFotIX9p/YPdl4TqUoMxL4ajNz7PbT89BqsdWJuBC9rvgt6wpbwTZqWWR0jKWqQbwsOWDBUZv4g==} dependencies: @@ -11857,6 +12061,79 @@ packages: micromark-util-symbol: 1.0.1 dev: true + /micromark-extension-gfm-autolink-literal/1.0.3: + resolution: {integrity: sha512-i3dmvU0htawfWED8aHMMAzAVp/F0Z+0bPh3YrbTPPL1v4YAlCZpy5rBO5p0LPYiZo0zFVkoYh7vDU7yQSiCMjg==} + dependencies: + micromark-util-character: 1.1.0 + micromark-util-sanitize-uri: 1.1.0 + micromark-util-symbol: 1.0.1 + micromark-util-types: 1.0.2 + uvu: 0.5.6 + dev: true + + /micromark-extension-gfm-footnote/1.0.4: + resolution: {integrity: sha512-E/fmPmDqLiMUP8mLJ8NbJWJ4bTw6tS+FEQS8CcuDtZpILuOb2kjLqPEeAePF1djXROHXChM/wPJw0iS4kHCcIg==} + dependencies: + micromark-core-commonmark: 1.0.6 + micromark-factory-space: 1.0.0 + micromark-util-character: 1.1.0 + micromark-util-normalize-identifier: 1.0.0 + micromark-util-sanitize-uri: 1.1.0 + micromark-util-symbol: 1.0.1 + micromark-util-types: 1.0.2 + uvu: 0.5.6 + dev: true + + /micromark-extension-gfm-strikethrough/1.0.4: + resolution: {integrity: sha512-/vjHU/lalmjZCT5xt7CcHVJGq8sYRm80z24qAKXzaHzem/xsDYb2yLL+NNVbYvmpLx3O7SYPuGL5pzusL9CLIQ==} + dependencies: + micromark-util-chunked: 1.0.0 + micromark-util-classify-character: 1.0.0 + micromark-util-resolve-all: 1.0.0 + micromark-util-symbol: 1.0.1 + micromark-util-types: 1.0.2 + uvu: 0.5.6 + dev: true + + /micromark-extension-gfm-table/1.0.5: + resolution: {integrity: sha512-xAZ8J1X9W9K3JTJTUL7G6wSKhp2ZYHrFk5qJgY/4B33scJzE2kpfRL6oiw/veJTbt7jiM/1rngLlOKPWr1G+vg==} + dependencies: + micromark-factory-space: 1.0.0 + micromark-util-character: 1.1.0 + micromark-util-symbol: 1.0.1 + micromark-util-types: 1.0.2 + uvu: 0.5.6 + dev: true + + /micromark-extension-gfm-tagfilter/1.0.1: + resolution: {integrity: sha512-Ty6psLAcAjboRa/UKUbbUcwjVAv5plxmpUTy2XC/3nJFL37eHej8jrHrRzkqcpipJliuBH30DTs7+3wqNcQUVA==} + dependencies: + micromark-util-types: 1.0.2 + dev: true + + /micromark-extension-gfm-task-list-item/1.0.3: + resolution: {integrity: sha512-PpysK2S1Q/5VXi72IIapbi/jliaiOFzv7THH4amwXeYXLq3l1uo8/2Be0Ac1rEwK20MQEsGH2ltAZLNY2KI/0Q==} + dependencies: + micromark-factory-space: 1.0.0 + micromark-util-character: 1.1.0 + micromark-util-symbol: 1.0.1 + micromark-util-types: 1.0.2 + uvu: 0.5.6 + dev: true + + /micromark-extension-gfm/2.0.1: + resolution: {integrity: sha512-p2sGjajLa0iYiGQdT0oelahRYtMWvLjy8J9LOCxzIQsllMCGLbsLW+Nc+N4vi02jcRJvedVJ68cjelKIO6bpDA==} + dependencies: + micromark-extension-gfm-autolink-literal: 1.0.3 + micromark-extension-gfm-footnote: 1.0.4 + micromark-extension-gfm-strikethrough: 1.0.4 + micromark-extension-gfm-table: 1.0.5 + micromark-extension-gfm-tagfilter: 1.0.1 + micromark-extension-gfm-task-list-item: 1.0.3 + micromark-util-combine-extensions: 1.0.0 + micromark-util-types: 1.0.2 + dev: true + /micromark-extension-mdx-expression/1.0.3: resolution: {integrity: sha512-TjYtjEMszWze51NJCZmhv7MEBcgYRgb3tJeMAJ+HQCAaZHHRBaDCccqQzGizR/H4ODefP44wRTgOn2vE5I6nZA==} dependencies: @@ -12237,13 +12514,15 @@ packages: yallist: 4.0.0 dev: true - /mintlify/1.3.0: - resolution: {integrity: sha512-5QBb07c5G2nm2ASVqcqaVZFRPq0zuly7v7H2BqwM6bsIR/6nAiyCBUWEmVbKDxjszNBcHGvaC5NV0w6y/MEwkg==} - engines: {node: '>=14.16'} + /mintlify/2.0.14: + resolution: {integrity: sha512-Xe6lE5w5hJKW70s1J+//CUzpH2QMhKF4sHMbxeA4baBIrtyQGdWfgeFjLaZrgXS/ghkQ16NU0Qtqs4EdilgtJg==} + engines: {node: '>=18.0.0'} hasBin: true dependencies: '@apidevtools/swagger-parser': 10.1.0_openapi-types@12.1.0 - axios: 1.1.3 + '@mintlify/validation': 0.1.4 + '@octokit/rest': 19.0.7 + axios: 1.2.2 chalk: 5.2.0 cheerio: 0.22.0 chokidar: 3.5.3 @@ -12251,6 +12530,7 @@ packages: fs-extra: 10.1.0 gray-matter: 4.0.3 inquirer: 9.1.4 + is-absolute-url: 4.0.1 is-internet-available: 3.1.0 minimist-lite: 2.2.1 node-html-markdown: 1.3.0 @@ -12258,7 +12538,12 @@ packages: openapi-types: 12.1.0 ora: 6.1.2 puppeteer: 19.5.2 + remark: 14.0.2 + remark-frontmatter: 4.0.1 + remark-gfm: 3.0.1 + remark-mdx: 2.2.1 shelljs: 0.8.5 + unist-util-visit: 4.1.1 yargs: 17.6.2 transitivePeerDependencies: - bufferutil @@ -12289,7 +12574,6 @@ packages: hasBin: true dependencies: minimist: 1.2.7 - dev: false /mkdirp/1.0.4: resolution: {integrity: sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==} @@ -12433,7 +12717,6 @@ packages: /nested-error-stacks/2.1.1: resolution: {integrity: sha512-9iN1ka/9zmX1ZvLV9ewJYEk9h7RyRRtqdK0woXcqohu8EWIerfPUjYJPg0ULy0UqP7cslmdGc8xKDJcojlKiaw==} - dev: false /netmask/2.0.2: resolution: {integrity: sha512-dBpDMdxv9Irdq66304OLfEmQ9tbNRFnFTuZiLo+bD+r332bBmMJ8GBLXklIXXgxd3+v9+KUnZaUR5PJMa75Gsg==} @@ -12529,7 +12812,6 @@ packages: hasBin: true dependencies: abbrev: 1.1.1 - dev: false /normalize-package-data/2.5.0: resolution: {integrity: sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA==} @@ -12859,7 +13141,6 @@ packages: engines: {node: '>=6'} dependencies: p-map: 2.1.0 - dev: false /p-cancelable/1.1.0: resolution: {integrity: sha512-s73XxOZ4zpt1edZYZzvhqFa6uvQc1vwUa0K0BdtIZgQMAJj9IbebH+JkgKZc9h+B05PKHLOTl4ajG1BmNrVZlw==} @@ -12876,19 +13157,16 @@ packages: engines: {node: '>=8'} dependencies: p-timeout: 3.2.0 - dev: false /p-filter/2.1.0: resolution: {integrity: sha512-ZBxxZ5sL2HghephhpGAQdoskxplTwr7ICaehZwLIlfL6acuVgZPm8yBNuRAFBGEqtD/hmUeq9eqLg2ys9Xr/yw==} engines: {node: '>=8'} dependencies: p-map: 2.1.0 - dev: false /p-finally/1.0.0: resolution: {integrity: sha512-LICb2p9CB7FS+0eR1oqWnHhp0FljGLZCWBE9aix0Uye9W8LTQPwMTYVGWQWIw9RdQiDg4+epXQODwIYJtSJaow==} engines: {node: '>=4'} - dev: false /p-limit/2.3.0: resolution: {integrity: sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==} @@ -12924,14 +13202,12 @@ packages: /p-map/2.1.0: resolution: {integrity: sha512-y3b8Kpd8OAN444hxfBbFfj1FY/RjtTd8tzYwhUqNYXx0fXx2iX4maP4Qr6qhIKbQXI02wTLAda4fYUbDagTUFw==} engines: {node: '>=6'} - dev: false /p-map/3.0.0: resolution: {integrity: sha512-d3qXVTF/s+W+CdJ5A29wywV2n8CQQYahlgz2bFiA+4eVNJbHJodPZ+/gXwPGh0bOqA+j8S+6+ckmvLGPk1QpxQ==} engines: {node: '>=8'} dependencies: aggregate-error: 3.1.0 - dev: false /p-map/4.0.0: resolution: {integrity: sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==} @@ -12945,7 +13221,6 @@ packages: engines: {node: '>=8'} dependencies: p-finally: 1.0.0 - dev: false /p-try/2.2.0: resolution: {integrity: sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==} @@ -13048,7 +13323,6 @@ packages: dependencies: leac: 0.6.0 peberminta: 0.8.0 - dev: false /parseurl/1.3.3: resolution: {integrity: sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==} @@ -13067,7 +13341,6 @@ packages: /path-dirname/1.0.2: resolution: {integrity: sha512-ALzNPpyNq9AqXMBjeymIjFDAkAFH06mHJH/cSBHAgU0s4vfpBn6b2nf8tiRLvagKD8RbTpq2FKTBg7cl9l3c7Q==} - dev: false /path-exists/3.0.0: resolution: {integrity: sha512-bpC7GYwiDYQ4wYLe+FA8lhRjhQCMcQGuSgGGqDkg/QerRWw9CmGRT0iSOVRSZJ29NMLZgIzqaljJ63oaL4NIJQ==} @@ -13123,7 +13396,6 @@ packages: /peberminta/0.8.0: resolution: {integrity: sha512-YYEs+eauIjDH5nUEGi18EohWE0nV2QbGTqmxQcqgZ/0g+laPCQmuIqq7EBLVi9uim9zMgfJv0QBZEnQ3uHw/Tw==} - dev: false /peek-stream/1.1.3: resolution: {integrity: sha512-FhJ+YbOSBb9/rIl2ZeE/QHEsWn7PqNYt8ARAY3kIgNGOk13g9FGyIY6JIl/xB/3TFRVoTv5as0l11weORrTekA==} @@ -13414,7 +13686,6 @@ packages: condense-newlines: 0.2.1 extend-shallow: 2.0.1 js-beautify: 1.14.7 - dev: false /prism-react-renderer/1.3.5_react@18.2.0: resolution: {integrity: sha512-IJ+MSwBWKG+SM3b2SUfdrhC+gu01QkV2KmRQgREThBfSQRoufqRfxfHUxpG1WcaFjP+kojcFyO9Qqtpgt3qLCg==} @@ -13472,7 +13743,6 @@ packages: /proto-list/1.2.4: resolution: {integrity: sha512-vtK/94akxsTMhe0/cbfpR+syPuszcuwhqVjJq26CuNDgFGj682oRBXOP5MJpv2r7JtE8MsiepGIqvvOTBwn2vA==} - dev: false /proxy-addr/2.0.7: resolution: {integrity: sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg==} @@ -13689,7 +13959,6 @@ packages: transitivePeerDependencies: - react - supports-color - dev: false /react-hot-toast/2.4.0_owo25xnefcwdq3zjgtohz6dbju: resolution: {integrity: sha512-qnnVbXropKuwUpriVVosgo8QrB+IaPJCpL8oBI6Ov84uvHZ5QQcTp2qg6ku2wNfgJl6rlQXJIQU5q+5lmPOutA==} @@ -13830,7 +14099,6 @@ packages: normalize-package-data: 2.5.0 parse-json: 5.2.0 type-fest: 0.6.0 - dev: false /read-yaml-file/1.1.0: resolution: {integrity: sha512-VIMnQi/Z4HT2Fxuwg5KrY174U1VdUIASQVWXXyqtNRtxSr9IYkn1rsI6Tb6HsrHCmB7gVpNwX6JxPTHcH6IoTA==} @@ -14026,6 +14294,17 @@ packages: unified: 10.1.2 dev: true + /remark-gfm/3.0.1: + resolution: {integrity: sha512-lEFDoi2PICJyNrACFOfDD3JlLkuSbOa5Wd8EPt06HUdptv8Gn0bxYTdbU/XXQ3swAPkEaGxxPN9cbnMHvVu1Ig==} + dependencies: + '@types/mdast': 3.0.10 + mdast-util-gfm: 2.0.1 + micromark-extension-gfm: 2.0.1 + unified: 10.1.2 + transitivePeerDependencies: + - supports-color + dev: true + /remark-mdx-frontmatter/1.1.1: resolution: {integrity: sha512-7teX9DW4tI2WZkXS4DBxneYSY7NHiXl4AKdWDO9LXVweULlCT8OPWsOjLEnMIXViN1j+QcY8mfbq3k0EK6x3uA==} engines: {node: '>=12.2.0'} @@ -14036,6 +14315,15 @@ packages: toml: 3.0.0 dev: true + /remark-mdx/2.2.1: + resolution: {integrity: sha512-R9wcN+/THRXTKyRBp6Npo/mcbGA2iT3N4G8qUqLA5pOEg7kBidHv8K2hHidCMYZ6DXmwK18umu0K4cicgA2PPQ==} + dependencies: + mdast-util-mdx: 2.0.0 + micromark-extension-mdxjs: 1.0.0 + transitivePeerDependencies: + - supports-color + dev: true + /remark-parse/10.0.1: resolution: {integrity: sha512-1fUyHr2jLsVOkhbvPRBJ5zTKZZyD6yZzYaWCS6BPBdQ8vEMBCH+9zNCDA6tET/zHCi/jLqjCWtlJZUPk+DbnFw==} dependencies: @@ -14055,6 +14343,25 @@ packages: unified: 10.1.2 dev: true + /remark-stringify/10.0.2: + resolution: {integrity: sha512-6wV3pvbPvHkbNnWB0wdDvVFHOe1hBRAx1Q/5g/EpH4RppAII6J8Gnwe7VbHuXaoKIF6LAg6ExTel/+kNqSQ7lw==} + dependencies: + '@types/mdast': 3.0.10 + mdast-util-to-markdown: 1.5.0 + unified: 10.1.2 + dev: true + + /remark/14.0.2: + resolution: {integrity: sha512-A3ARm2V4BgiRXaUo5K0dRvJ1lbogrbXnhkJRmD0yw092/Yl0kOCZt1k9ZeElEwkZsWGsMumz6qL5MfNJH9nOBA==} + dependencies: + '@types/mdast': 3.0.10 + remark-parse: 10.0.1 + remark-stringify: 10.0.2 + unified: 10.1.2 + transitivePeerDependencies: + - supports-color + dev: true + /remix-auth-email-link/1.5.2_m4c7eayociv7q7p6sha75wrvim: resolution: {integrity: sha512-LCbaYkhsENbRK70O36Ul/jBtvNcNdBabjOIXYhrTNwx4qYA/fFkX8Sr3GMuDhoMzHnXQy7zHtsqbg/DTHocX6g==} peerDependencies: @@ -14278,7 +14585,6 @@ packages: hasBin: true dependencies: glob: 7.2.3 - dev: false /rimraf/3.0.2: resolution: {integrity: sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==} @@ -14406,7 +14712,6 @@ packages: resolution: {integrity: sha512-DEL/RW/f4qLw/NrVg97xKaEBC8IpzIG2fvxnzCp3Z4yk4jQ3MXom+Imav9wApjxX2dfS3eW7x0DXafJr85i39A==} dependencies: parseley: 0.11.0 - dev: false /sembear/0.5.2: resolution: {integrity: sha512-Ij1vCAdFgWABd7zTg50Xw1/p0JgESNxuLlneEAsmBrKishA06ulTTL/SHGmNy2Zud7+rKrHTKNI6moJsn1ppAQ==} @@ -14484,7 +14789,6 @@ packages: /setimmediate/1.0.5: resolution: {integrity: sha512-MATJdZp8sLqDl/68LfQmbP8zKPLQNV6BIZoIgrscFDQ+RsvK/BxeDQOgyxKKoh0y/8h3BqVFnCqQ/gd+reiIXA==} - dev: false /setprototypeof/1.2.0: resolution: {integrity: sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==} @@ -14557,7 +14861,6 @@ packages: /sigmund/1.0.1: resolution: {integrity: sha512-fCvEXfh6NWpm+YSuY2bpXb/VIihqWA6hLsgboC+0nl71Q7N7o2eaCW8mJa/NLvQhs6jpd3VZV4UiUQlV6+lc8g==} - dev: false /signal-exit/3.0.7: resolution: {integrity: sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==} @@ -14590,7 +14893,6 @@ packages: /slash/2.0.0: resolution: {integrity: sha512-ZYKh3Wh2z1PpEXWr0MpSBZ0V6mZHAQfYevttO11c51CaWjGTaadiKZ+wVt1PbMlDV5qhMFslpZCemhwOK7C89A==} engines: {node: '>=6'} - dev: false /slash/3.0.0: resolution: {integrity: sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==} @@ -15392,7 +15694,6 @@ packages: /traverse/0.3.9: resolution: {integrity: sha512-iawgk0hLP3SxGKDfnDJf8wTz4p2qImnyihM5Hh/sGvQ3K37dPi/w8sRhdNIxYA1TwFwc5mDhIJq+O0RsvXBKdQ==} - dev: false /tree-kill/1.2.2: resolution: {integrity: sha512-L0Orpi8qGpRG//Nd+H90vFB+3iHnue1zSSGmNOOCh1GLJ7rUKVwV2HvijphGQS2UmhUZewS9VgvxYIdgr+fG1A==} @@ -15406,7 +15707,6 @@ packages: commander: 5.1.0 fast-folder-size: 1.6.1 pretty-bytes: 5.6.0 - dev: false /trim-newlines/3.0.1: resolution: {integrity: sha512-c1PTsA3tYrIsLGkJkzHF+w9F2EyxfXGo4UyJc4pFL++FMjnq0HJS69T3M7d//gKrFKwy429bouPescbjecU+Zw==} @@ -15703,7 +16003,6 @@ packages: /type-fest/0.6.0: resolution: {integrity: sha512-q+MB8nYR1KDLrgr4G5yemftpMC7/QLqVndBmEEdqzmNj5dcFOO4Oo8qlwZE3ULT3+Zim1F8Kq4cBnikNhlCMlg==} engines: {node: '>=8'} - dev: false /type-fest/0.8.1: resolution: {integrity: sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==} @@ -15883,6 +16182,10 @@ packages: unist-util-visit-parents: 5.1.1 dev: true + /universal-user-agent/6.0.0: + resolution: {integrity: sha512-isyNax3wXoKaulPDZWHQqbmIx1k2tb9fb3GGDBRxCscfYV2Ch7WxPArBsFEG8s/safwXTT7H4QGhaIkTp9447w==} + dev: true + /universalify/0.1.2: resolution: {integrity: sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==} engines: {node: '>= 4.0.0'} @@ -15928,7 +16231,6 @@ packages: listenercount: 1.0.1 readable-stream: 2.3.7 setimmediate: 1.0.5 - dev: false /update-browserslist-db/1.0.10_browserslist@4.21.4: resolution: {integrity: sha512-OztqDenkfFkbSG+tRxBeAnCVPckDBcvibKd35yDONx6OU8N7sqgwc7rCbkJ/WcYtVRZ4ba68d6byhC21GFh7sQ==} @@ -15958,7 +16260,7 @@ packages: prepend-http: 2.0.0 dev: true - /urql/3.0.3_graphql@16.6.0: + /urql/3.0.3_onqnqwb3ubg5opvemcqf7c2qhy: resolution: {integrity: sha512-aVUAMRLdc5AOk239DxgXt6ZxTl/fEmjr7oyU5OGo8uvpqu42FkeJErzd2qBzhAQ3DyusoZIbqbBLPlnKo/yy2A==} peerDependencies: graphql: ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 @@ -15966,6 +16268,7 @@ packages: dependencies: '@urql/core': 3.1.1_graphql@16.6.0 graphql: 16.6.0 + react: 18.2.0 wonka: 6.1.2 dev: false @@ -16581,6 +16884,20 @@ packages: resolution: {integrity: sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==} engines: {node: '>=10'} + /zod-error/1.1.0: + resolution: {integrity: sha512-zZ0I9/eFQsaDqglBPOM5Y/kJzbTkoD6hNZGON/kcMe2WIfLse2DIwsZpLMfKwBmcciYaEg+DubtLMnAbZ4/rfA==} + dependencies: + zod: 3.20.2 + dev: false + + /zod-to-json-schema/3.20.2_zod@3.20.2: + resolution: {integrity: sha512-qka3UAXmVXD8z5SHkRU89UyHp8JHJW7zc8RQCpt7QloJOn6uijwkjUm8o+M/cF1IysmKc5gxac/QeDikaQMdzQ==} + peerDependencies: + zod: ^3.20.0 + dependencies: + zod: 3.20.2 + dev: true + /zod/3.20.2: resolution: {integrity: sha512-1MzNQdAvO+54H+EaK5YpyEy0T+Ejo/7YLHS93G3RnYWh5gaotGHwGeN/ZO687qEDU2y4CdStQYXVHIgrUl5UVQ==}