cyrus-github-event-transport 0.2.22

package/dist/types.d.ts

@@ -0,0 +1,171 @@
+/**
+ * Types for GitHub event transport
+ */
+import type { InternalMessage } from "cyrus-core";
+import type { FastifyInstance } from "fastify";
+/**
+ * Verification mode for GitHub webhooks forwarded from CYHOST
+ * - 'proxy': Use CYRUS_API_KEY Bearer token for authentication (self-hosted)
+ * - 'signature': Use x-hub-signature-256 GitHub HMAC-SHA256 signature verification (cloud)
+ */
+export type GitHubVerificationMode = "proxy" | "signature";
+/**
+ * Configuration for GitHubEventTransport
+ */
+export interface GitHubEventTransportConfig {
+    /** Fastify server instance to mount routes on */
+    fastifyServer: FastifyInstance;
+    /** Verification mode: 'proxy' or 'signature' */
+    verificationMode: GitHubVerificationMode;
+    /** Secret for verification (CYRUS_API_KEY for proxy, GITHUB_WEBHOOK_SECRET for signature) */
+    secret: string;
+}
+/**
+ * Events emitted by GitHubEventTransport
+ */
+export interface GitHubEventTransportEvents {
+    /** Emitted when a GitHub webhook is received and verified (legacy) */
+    event: (event: GitHubWebhookEvent) => void;
+    /** Emitted when a unified internal message is received */
+    message: (message: InternalMessage) => void;
+    /** Emitted when an error occurs */
+    error: (error: Error) => void;
+}
+/**
+ * Processed GitHub webhook event that is emitted to listeners
+ */
+export interface GitHubWebhookEvent {
+    /** The GitHub event type (e.g., 'issue_comment', 'pull_request_review_comment') */
+    eventType: GitHubEventType;
+    /** Unique webhook delivery ID */
+    deliveryId: string;
+    /** The full GitHub webhook payload */
+    payload: GitHubIssueCommentPayload | GitHubPullRequestReviewCommentPayload;
+    /** GitHub installation token forwarded from CYHOST (1-hour expiry) */
+    installationToken?: string;
+}
+/**
+ * Supported GitHub webhook event types
+ */
+export type GitHubEventType = "issue_comment" | "pull_request_review_comment";
+/**
+ * GitHub user object (minimal)
+ */
+export interface GitHubUser {
+    login: string;
+    id: number;
+    avatar_url: string;
+    html_url: string;
+    type: string;
+}
+/**
+ * GitHub repository object (minimal)
+ */
+export interface GitHubRepository {
+    id: number;
+    name: string;
+    full_name: string;
+    html_url: string;
+    clone_url: string;
+    ssh_url: string;
+    default_branch: string;
+    owner: GitHubUser;
+}
+/**
+ * GitHub PR reference (head/base)
+ */
+export interface GitHubPullRequestRef {
+    label: string;
+    ref: string;
+    sha: string;
+    repo: GitHubRepository;
+}
+/**
+ * GitHub Pull Request object (minimal, used in issue_comment context)
+ */
+export interface GitHubPullRequestMinimal {
+    url: string;
+    html_url: string;
+    diff_url: string;
+    patch_url: string;
+}
+/**
+ * GitHub Pull Request object (full, used in pull_request_review_comment context)
+ */
+export interface GitHubPullRequest {
+    id: number;
+    number: number;
+    title: string;
+    body: string | null;
+    state: string;
+    html_url: string;
+    url: string;
+    head: GitHubPullRequestRef;
+    base: GitHubPullRequestRef;
+    user: GitHubUser;
+}
+/**
+ * GitHub Issue object (used in issue_comment webhook)
+ */
+export interface GitHubIssue {
+    id: number;
+    number: number;
+    title: string;
+    body: string | null;
+    state: string;
+    html_url: string;
+    url: string;
+    user: GitHubUser;
+    /** Present when the issue is a PR */
+    pull_request?: GitHubPullRequestMinimal;
+}
+/**
+ * GitHub comment object
+ */
+export interface GitHubComment {
+    id: number;
+    body: string;
+    html_url: string;
+    url: string;
+    user: GitHubUser;
+    created_at: string;
+    updated_at: string;
+    /** For PR review comments: the file path being commented on */
+    path?: string;
+    /** For PR review comments: the diff hunk */
+    diff_hunk?: string;
+    /** For PR review comments: the commit being commented on */
+    commit_id?: string;
+}
+/**
+ * GitHub installation object (for GitHub App)
+ */
+export interface GitHubInstallation {
+    id: number;
+    node_id: string;
+}
+/**
+ * Payload for issue_comment webhook events
+ * @see https://docs.github.com/en/webhooks/webhook-events-and-payloads#issue_comment
+ */
+export interface GitHubIssueCommentPayload {
+    action: "created" | "edited" | "deleted";
+    issue: GitHubIssue;
+    comment: GitHubComment;
+    repository: GitHubRepository;
+    sender: GitHubUser;
+    installation?: GitHubInstallation;
+}
+/**
+ * Payload for pull_request_review_comment webhook events
+ * @see https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request_review_comment
+ */
+export interface GitHubPullRequestReviewCommentPayload {
+    action: "created" | "edited" | "deleted";
+    comment: GitHubComment;
+    pull_request: GitHubPullRequest;
+    repository: GitHubRepository;
+    sender: GitHubUser;
+    installation?: GitHubInstallation;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,OAAO,GAAG,WAAW,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C,iDAAiD;IACjD,aAAa,EAAE,eAAe,CAAC;IAC/B,gDAAgD;IAChD,gBAAgB,EAAE,sBAAsB,CAAC;IACzC,6FAA6F;IAC7F,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C,sEAAsE;IACtE,KAAK,EAAE,CAAC,KAAK,EAAE,kBAAkB,KAAK,IAAI,CAAC;IAC3C,0DAA0D;IAC1D,OAAO,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,CAAC;IAC5C,mCAAmC;IACnC,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,mFAAmF;IACnF,SAAS,EAAE,eAAe,CAAC;IAC3B,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,OAAO,EAAE,yBAAyB,GAAG,qCAAqC,CAAC;IAC3E,sEAAsE;IACtE,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG,6BAA6B,CAAC;AAS9E;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,UAAU,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,gBAAgB,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,oBAAoB,CAAC;IAC3B,IAAI,EAAE,oBAAoB,CAAC;IAC3B,IAAI,EAAE,UAAU,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,UAAU,CAAC;IACjB,qCAAqC;IACrC,YAAY,CAAC,EAAE,wBAAwB,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,UAAU,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,+DAA+D;IAC/D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4CAA4C;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACzC,MAAM,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IACzC,KAAK,EAAE,WAAW,CAAC;IACnB,OAAO,EAAE,aAAa,CAAC;IACvB,UAAU,EAAE,gBAAgB,CAAC;IAC7B,MAAM,EAAE,UAAU,CAAC;IACnB,YAAY,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,qCAAqC;IACrD,MAAM,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IACzC,OAAO,EAAE,aAAa,CAAC;IACvB,YAAY,EAAE,iBAAiB,CAAC;IAChC,UAAU,EAAE,gBAAgB,CAAC;IAC7B,MAAM,EAAE,UAAU,CAAC;IACnB,YAAY,CAAC,EAAE,kBAAkB,CAAC;CAClC"}

package/dist/types.js

@@ -0,0 +1,5 @@
+/**
+ * Types for GitHub event transport
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "cyrus-github-event-transport",
+  "version": "0.2.22",
+  "description": "GitHub event transport for receiving and verifying forwarded GitHub webhooks",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "fastify": "^5.2.0",
+    "cyrus-core": "0.2.22"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.3.3",
+    "vitest": "^3.1.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest",
+    "test:run": "vitest run"
+  }
+}