cyrus-gitlab-event-transport 0.2.38

package/dist/types.d.ts

@@ -0,0 +1,169 @@
+/**
+ * Types for GitLab event transport
+ */
+import type { InternalMessage } from "cyrus-core";
+import type { FastifyInstance } from "fastify";
+/**
+ * Verification mode for GitLab webhooks
+ * - 'proxy': Use CYRUS_API_KEY Bearer token for authentication (self-hosted via CYHOST)
+ * - 'signature': Use X-Gitlab-Token secret token verification (direct webhooks)
+ */
+export type GitLabVerificationMode = "proxy" | "signature";
+/**
+ * Configuration for GitLabEventTransport
+ */
+export interface GitLabEventTransportConfig {
+    /** Fastify server instance to mount routes on */
+    fastifyServer: FastifyInstance;
+    /** Verification mode: 'proxy' or 'signature' */
+    verificationMode: GitLabVerificationMode;
+    /** Secret for verification (CYRUS_API_KEY for proxy, GITLAB_WEBHOOK_SECRET for signature) */
+    secret: string;
+}
+/**
+ * Events emitted by GitLabEventTransport
+ */
+export interface GitLabEventTransportEvents {
+    /** Emitted when a GitLab webhook is received and verified (legacy) */
+    event: (event: GitLabWebhookEvent) => void;
+    /** Emitted when a unified internal message is received */
+    message: (message: InternalMessage) => void;
+    /** Emitted when an error occurs */
+    error: (error: Error) => void;
+}
+/**
+ * Processed GitLab webhook event that is emitted to listeners
+ */
+export interface GitLabWebhookEvent {
+    /** The GitLab event type */
+    eventType: GitLabEventType;
+    /** The full GitLab webhook payload */
+    payload: GitLabNotePayload | GitLabMergeRequestPayload;
+    /** GitLab access token forwarded from CYHOST */
+    accessToken?: string;
+}
+/**
+ * Supported GitLab webhook event types
+ */
+export type GitLabEventType = "note" | "merge_request";
+/**
+ * GitLab user object (minimal)
+ */
+export interface GitLabUser {
+    id: number;
+    name: string;
+    username: string;
+    avatar_url: string;
+    email?: string;
+}
+/**
+ * GitLab project object
+ */
+export interface GitLabProject {
+    id: number;
+    name: string;
+    description: string | null;
+    web_url: string;
+    git_ssh_url: string;
+    git_http_url: string;
+    namespace: string;
+    path_with_namespace: string;
+    default_branch: string;
+    homepage: string;
+    url: string;
+    ssh_url: string;
+    http_url: string;
+}
+/**
+ * GitLab merge request object (as embedded in webhook payloads)
+ */
+export interface GitLabMergeRequest {
+    id: number;
+    iid: number;
+    title: string;
+    description: string | null;
+    state: string;
+    url: string;
+    source_branch: string;
+    target_branch: string;
+    source_project_id: number;
+    target_project_id: number;
+    author_id: number;
+    assignee_id: number | null;
+    created_at: string;
+    updated_at: string;
+    action?: string;
+}
+/**
+ * GitLab note (comment) object attributes
+ */
+export interface GitLabNoteAttributes {
+    id: number;
+    note: string;
+    noteable_type: "MergeRequest" | "Issue" | "Snippet" | "Commit";
+    author_id: number;
+    created_at: string;
+    updated_at: string;
+    project_id: number;
+    url: string;
+    type: string | null;
+    description?: string;
+    /** Discussion ID for threaded notes */
+    discussion_id?: string;
+    /** For diff notes: position data */
+    position?: {
+        base_sha: string;
+        start_sha: string;
+        head_sha: string;
+        old_path: string;
+        new_path: string;
+        position_type: string;
+        old_line: number | null;
+        new_line: number | null;
+    };
+}
+/**
+ * Payload for note (comment) webhook events
+ * @see https://docs.gitlab.com/ee/user/project/integrations/webhook_events.html#comment-events
+ */
+export interface GitLabNotePayload {
+    object_kind: "note";
+    event_type: "note";
+    user: GitLabUser;
+    project: GitLabProject;
+    object_attributes: GitLabNoteAttributes;
+    /** Present when the note is on a merge request */
+    merge_request?: GitLabMergeRequest;
+    /** Repository info */
+    repository?: {
+        name: string;
+        url: string;
+        description: string | null;
+        homepage: string;
+    };
+}
+/**
+ * Merge request object_attributes in webhook payload
+ */
+export interface GitLabMergeRequestAttributes extends GitLabMergeRequest {
+    action: string;
+}
+/**
+ * Payload for merge_request webhook events
+ * @see https://docs.gitlab.com/ee/user/project/integrations/webhook_events.html#merge-request-events
+ */
+export interface GitLabMergeRequestPayload {
+    object_kind: "merge_request";
+    event_type: "merge_request";
+    user: GitLabUser;
+    project: GitLabProject;
+    object_attributes: GitLabMergeRequestAttributes;
+    /** Repository info */
+    repository?: {
+        name: string;
+        url: string;
+        description: string | null;
+        homepage: string;
+    };
+}
+//# 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,4BAA4B;IAC5B,SAAS,EAAE,eAAe,CAAC;IAC3B,sCAAsC;IACtC,OAAO,EAAE,iBAAiB,GAAG,yBAAyB,CAAC;IACvD,gDAAgD;IAChD,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,eAAe,CAAC;AASvD;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,cAAc,GAAG,OAAO,GAAG,SAAS,GAAG,QAAQ,CAAC;IAC/D,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uCAAuC;IACvC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,QAAQ,CAAC,EAAE;QACV,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,EAAE,MAAM,CAAC;QACtB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,EAAE,aAAa,CAAC;IACvB,iBAAiB,EAAE,oBAAoB,CAAC;IACxC,kDAAkD;IAClD,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC,sBAAsB;IACtB,UAAU,CAAC,EAAE;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,QAAQ,EAAE,MAAM,CAAC;KACjB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,kBAAkB;IACvE,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACzC,WAAW,EAAE,eAAe,CAAC;IAC7B,UAAU,EAAE,eAAe,CAAC;IAC5B,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,EAAE,aAAa,CAAC;IACvB,iBAAiB,EAAE,4BAA4B,CAAC;IAChD,sBAAsB;IACtB,UAAU,CAAC,EAAE;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,QAAQ,EAAE,MAAM,CAAC;KACjB,CAAC;CACF"}

package/dist/types.js

@@ -0,0 +1,5 @@
+/**
+ * Types for GitLab 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-gitlab-event-transport",
+  "version": "0.2.38",
+  "description": "GitLab event transport for receiving and verifying forwarded GitLab webhooks",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "fastify": "^5.8.1",
+    "cyrus-core": "0.2.38"
+  },
+  "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 --passWithNoTests"
+  }
+}