@automate.ax/integration-contracts 0.88.2 → 0.88.3

package/src/github/webhook-operations.ts

@@ -0,0 +1,171 @@
+/* oxlint-disable typescript/no-unsafe-type-assertion -- Membership checks narrow the two disjoint generated operation maps. */
+const GITHUB_WEBHOOK_ACTIONS = {
+  check_run: ["completed", "created", "requested_action", "rerequested"],
+  check_suite: ["completed", "requested", "rerequested"],
+  commit_comment: ["created"],
+  deployment: ["created"],
+  deployment_protection_rule: ["requested"],
+  deployment_review: ["approved", "rejected", "requested"],
+  deployment_status: ["created"],
+  installation: [
+    "created",
+    "deleted",
+    "new_permissions_accepted",
+    "suspend",
+    "unsuspend",
+  ],
+  installation_repositories: ["added", "removed"],
+  installation_target: ["renamed"],
+  issue_comment: ["created", "deleted", "edited", "pinned", "unpinned"],
+  issue_dependencies: [
+    "blocked_by_added",
+    "blocked_by_removed",
+    "blocking_added",
+    "blocking_removed",
+  ],
+  issues: [
+    "assigned",
+    "closed",
+    "deleted",
+    "demilestoned",
+    "edited",
+    "field_added",
+    "field_removed",
+    "labeled",
+    "locked",
+    "milestoned",
+    "opened",
+    "pinned",
+    "reopened",
+    "transferred",
+    "typed",
+    "unassigned",
+    "unlabeled",
+    "unlocked",
+    "unpinned",
+    "untyped",
+  ],
+  merge_group: ["checks_requested", "destroyed"],
+  pull_request: [
+    "assigned",
+    "auto_merge_disabled",
+    "auto_merge_enabled",
+    "closed",
+    "converted_to_draft",
+    "demilestoned",
+    "dequeued",
+    "edited",
+    "enqueued",
+    "labeled",
+    "locked",
+    "milestoned",
+    "opened",
+    "ready_for_review",
+    "reopened",
+    "review_request_removed",
+    "review_requested",
+    "stacked",
+    "synchronize",
+    "unassigned",
+    "unlabeled",
+    "unlocked",
+  ],
+  pull_request_review: ["dismissed", "edited", "submitted"],
+  pull_request_review_comment: ["created", "deleted", "edited"],
+  pull_request_review_thread: ["resolved", "unresolved"],
+  release: [
+    "created",
+    "deleted",
+    "edited",
+    "prereleased",
+    "published",
+    "released",
+    "unpublished",
+  ],
+  repository: [
+    "archived",
+    "created",
+    "deleted",
+    "edited",
+    "privatized",
+    "publicized",
+    "renamed",
+    "transferred",
+    "unarchived",
+  ],
+  sub_issues: [
+    "parent_issue_added",
+    "parent_issue_removed",
+    "sub_issue_added",
+    "sub_issue_removed",
+  ],
+  workflow_job: ["completed", "in_progress", "queued", "waiting"],
+  workflow_run: ["completed", "in_progress", "requested"],
+} as const
+
+const GITHUB_ACTIONLESS_WEBHOOK_OPERATIONS = {
+  create: "create",
+  delete: "delete",
+  push: "push",
+  repository_dispatch: "repository-dispatch-sample.collected",
+  status: "status",
+  workflow_dispatch: "workflow-dispatch",
+} as const
+
+/** Resolves an action discriminator across the generated event family map. */
+type GitHubWebhookActionForOperation<TOperation extends string> = {
+  [TEventName in keyof typeof GITHUB_WEBHOOK_ACTIONS]: {
+    [TAction in (typeof GITHUB_WEBHOOK_ACTIONS)[TEventName][number]]: `${ReplaceUnderscores<TEventName>}-${ReplaceUnderscores<TAction>}` extends TOperation
+      ? TAction
+      : never
+  }[(typeof GITHUB_WEBHOOK_ACTIONS)[TEventName][number]]
+}[keyof typeof GITHUB_WEBHOOK_ACTIONS]
+
+/** Action discriminator required by one classified webhook operation. */
+export type GitHubWebhookAction<TOperation extends string> =
+  TOperation extends string
+    ? GitHubWebhookActionForOperation<TOperation>
+    : never
+
+type ReplaceUnderscores<TValue extends string> =
+  TValue extends `${infer THead}_${infer TTail}`
+    ? `${THead}-${ReplaceUnderscores<TTail>}`
+    : TValue
+
+export type GitHubWebhookEventName =
+  | keyof typeof GITHUB_ACTIONLESS_WEBHOOK_OPERATIONS
+  | keyof typeof GITHUB_WEBHOOK_ACTIONS
+
+export const GITHUB_WEBHOOK_OPERATIONS = [
+  ...Object.values(GITHUB_ACTIONLESS_WEBHOOK_OPERATIONS),
+  ...Object.entries(GITHUB_WEBHOOK_ACTIONS).flatMap(([eventName, actions]) =>
+    actions.map(
+      (action) =>
+        `${eventName.replaceAll("_", "-")}-${action.replaceAll("_", "-")}`,
+    ),
+  ),
+] as const
+
+/**
+ * Resolves one GitHub event header and body to its frozen OpenAPI operation.
+ *
+ * @param eventName - GitHub event header value.
+ * @param value - Parsed webhook body.
+ */
+export function getGitHubWebhookOperation(
+  eventName: GitHubWebhookEventName,
+  value: unknown,
+) {
+  if (eventName in GITHUB_ACTIONLESS_WEBHOOK_OPERATIONS) {
+    return GITHUB_ACTIONLESS_WEBHOOK_OPERATIONS[
+      eventName as keyof typeof GITHUB_ACTIONLESS_WEBHOOK_OPERATIONS
+    ]
+  }
+  if (!value || typeof value !== "object" || !("action" in value)) return
+  const action = value.action
+  const actions = GITHUB_WEBHOOK_ACTIONS[
+    eventName as keyof typeof GITHUB_WEBHOOK_ACTIONS
+  ] as readonly string[]
+  if (typeof action !== "string" || !actions.includes(action)) return
+  return `${eventName.replaceAll("_", "-")}-${action.replaceAll("_", "-")}`
+}