@devrev/git-sdk 0.11.0

package/dist/orchestrator/event_orchestrator.js

@@ -0,0 +1,137 @@
+"use strict";
+/**
+ * Event Orchestrator for the Git SDK.
+ *
+ * The orchestrator is the central routing layer that receives raw events from
+ * any Git provider, normalizes them via the provider adapter, and dispatches
+ * them to the appropriate handler. This simplifies the consumer experience —
+ * instead of manually normalizing events and routing to individual handlers,
+ * consumers call a single `processEvent()` method.
+ *
+ * Flow:
+ * 1. Raw provider event → adapter.normalizeEvent() → NormalizedEvent
+ * 2. NormalizedEvent.type → route to correct handler
+ * 3. Handler processes event → HandlerResult
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventOrchestrator = void 0;
+const client_1 = require("../devrev/client");
+const types_1 = require("../devrev/types");
+const registry_1 = require("../handlers/registry");
+// =============================================================================
+// Event Orchestrator
+// =============================================================================
+/**
+ * Central event processing engine for the Git SDK.
+ *
+ * The EventOrchestrator ties together the provider adapter (normalization)
+ * and the event handlers (processing) into a single, easy-to-use interface.
+ *
+ * Usage:
+ * 1. Create an orchestrator with SDK configuration, a provider adapter, and a provider name.
+ * 2. Call `processEvent(rawEvent)` for each incoming webhook payload.
+ * 3. The orchestrator normalizes the event and routes it to the correct handler.
+ *
+ * @example
+ * ```typescript
+ * const orchestrator = new EventOrchestrator({
+ *   sdkConfig: {
+ *     devrev: { endpoint: 'https://api.devrev.ai', token: devrevToken },
+ *     provider: { token: providerToken },
+ *   },
+ *   adapter: myProviderAdapter,
+ *   provider: 'github', // or 'gitlab', 'bitbucket', 'azure'
+ * });
+ *
+ * // Process a raw webhook payload
+ * const result = await orchestrator.processEvent(webhookPayload);
+ * console.log(result.success, result.message);
+ * ```
+ */
+class EventOrchestrator {
+    /**
+     * Creates a new EventOrchestrator.
+     *
+     * Internally builds a DevRevClient from the provided SDKConfiguration.
+     *
+     * @param config - The orchestrator configuration
+     */
+    constructor(config) {
+        this.client = new client_1.DevRevClient({
+            endpoint: config.sdkConfig.devrev.endpoint,
+            token: config.sdkConfig.devrev.token,
+            provider: config.provider,
+        });
+        this.adapter = config.adapter;
+        this.source = (0, types_1.getCodeChangeSourceFromProvider)(config.provider);
+    }
+    /**
+     * Processes a raw event from a Git provider.
+     *
+     * This is the primary entry point for event processing. It:
+     * 1. Normalizes the raw event via the provider adapter
+     * 2. Routes the normalized event to the appropriate handler
+     * 3. Returns the handler result
+     *
+     * @param rawEvent - The raw event payload from the Git provider
+     * @returns The handler result indicating success or failure
+     */
+    processEvent(rawEvent) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const normalizedEvent = this.adapter.normalizeEvent(rawEvent);
+                return yield this.processNormalizedEvent(normalizedEvent);
+            }
+            catch (error) {
+                return {
+                    message: `Failed to process event: ${(0, types_1.getErrorMessage)(error)}`,
+                    success: false,
+                };
+            }
+        });
+    }
+    /**
+     * Processes a pre-normalized event.
+     *
+     * Use this when the event has already been normalized (e.g., in testing
+     * or when the normalization step is handled externally).
+     *
+     * @param event - The normalized event
+     * @returns The handler result indicating success or failure
+     */
+    processNormalizedEvent(event) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const handler = registry_1.DEFAULT_HANDLER_REGISTRY[event.type];
+            if (!handler) {
+                return {
+                    message: `No handler registered for event type: ${event.type}`,
+                    success: false,
+                };
+            }
+            const context = this.buildHandlerContext(event.type);
+            return handler(event, context);
+        });
+    }
+    /**
+     * Builds the HandlerContext for a given event type.
+     */
+    buildHandlerContext(eventType) {
+        return {
+            adapter: this.adapter,
+            client: this.client,
+            eventType,
+            source: this.source,
+        };
+    }
+}
+exports.EventOrchestrator = EventOrchestrator;
+//# sourceMappingURL=event_orchestrator.js.map

package/dist/orchestrator/event_orchestrator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event_orchestrator.js","sourceRoot":"","sources":["../../src/orchestrator/event_orchestrator.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG;;;;;;;;;;;;AAGH,6CAAgD;AAChD,2CAAyG;AACzG,mDAAgE;AA2BhE,gFAAgF;AAChF,qBAAqB;AACrB,gFAAgF;AAEhF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAa,iBAAiB;IAO5B;;;;;;OAMG;IACH,YAAY,MAA+B;QACzC,IAAI,CAAC,MAAM,GAAG,IAAI,qBAAY,CAAC;YAC7B,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ;YAC1C,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK;YACpC,QAAQ,EAAE,MAAM,CAAC,QAAQ;SAC1B,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,IAAA,uCAA+B,EAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;OAUG;IACG,YAAY,CAAC,QAAiB;;YAClC,IAAI;gBACF,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;gBAC9D,OAAO,MAAM,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,CAAC;aAC3D;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO;oBACL,OAAO,EAAE,4BAA4B,IAAA,uBAAe,EAAC,KAAK,CAAC,EAAE;oBAC7D,OAAO,EAAE,KAAK;iBACf,CAAC;aACH;QACH,CAAC;KAAA;IAED;;;;;;;;OAQG;IACG,sBAAsB,CAAC,KAAsB;;YACjD,MAAM,OAAO,GAAG,mCAAwB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAErD,IAAI,CAAC,OAAO,EAAE;gBACZ,OAAO;oBACL,OAAO,EAAE,yCAAyC,KAAK,CAAC,IAAI,EAAE;oBAC9D,OAAO,EAAE,KAAK;iBACf,CAAC;aACH;YAED,MAAM,OAAO,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACrD,OAAO,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACjC,CAAC;KAAA;IAED;;OAEG;IACK,mBAAmB,CAAC,SAAiB;QAC3C,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,SAAS;YACT,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC;IACJ,CAAC;CACF;AAjFD,8CAiFC"}

package/dist/orchestrator/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Event orchestrator module.
+ *
+ * Provides the central event processing engine that normalizes raw
+ * Git provider events and routes them to the appropriate handlers.
+ */
+export { EventOrchestrator, type EventOrchestratorConfig, } from './event_orchestrator';

package/dist/orchestrator/index.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * Event orchestrator module.
+ *
+ * Provides the central event processing engine that normalizes raw
+ * Git provider events and routes them to the appropriate handlers.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventOrchestrator = void 0;
+var event_orchestrator_1 = require("./event_orchestrator");
+Object.defineProperty(exports, "EventOrchestrator", { enumerable: true, get: function () { return event_orchestrator_1.EventOrchestrator; } });
+//# sourceMappingURL=index.js.map

package/dist/orchestrator/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/orchestrator/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,2DAG8B;AAF5B,uHAAA,iBAAiB,OAAA"}

package/dist/types/config.d.ts

@@ -0,0 +1,22 @@
+/**
+ * SDK configuration types.
+ */
+import { ProviderContext } from './provider';
+/**
+ * DevRev API configuration.
+ */
+export interface DevRevConfig {
+    /** DevRev API endpoint */
+    endpoint: string;
+    /** DevRev API token */
+    token: string;
+}
+/**
+ * Complete SDK configuration.
+ */
+export interface SDKConfiguration {
+    /** DevRev API configuration */
+    devrev: DevRevConfig;
+    /** Provider context with auth token */
+    provider: ProviderContext;
+}

package/dist/types/config.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * SDK configuration types.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=config.js.map

package/dist/types/config.js.map

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

package/dist/types/events.d.ts

@@ -0,0 +1,50 @@
+import { NormalizedRepository, NormalizedActor, NormalizedCommit, NormalizedPullRequest, NormalizedBranch } from './types';
+import { GitProvider } from './provider';
+export declare const ReviewStateValues: {
+    readonly APPROVED: "APPROVED";
+    readonly CHANGES_REQUESTED: "CHANGES_REQUESTED";
+};
+export type ReviewState = typeof ReviewStateValues[keyof typeof ReviewStateValues];
+interface NormalizedEventBase {
+    provider: GitProvider;
+    actor: NormalizedActor;
+    repository: NormalizedRepository;
+    occurredAt: string;
+}
+export type NormalizedEvent = NormalizedPushEvent | NormalizedPullRequestCreateEvent | NormalizedPullRequestEditEvent | NormalizedPRReviewEvent | NormalizedPullRequestCloseEvent | NormalizedPullRequestMergeEvent;
+export interface NormalizedPushEvent extends NormalizedEventBase {
+    type: 'push';
+    branch: NormalizedBranch;
+    commits: NormalizedCommit[];
+    beforeSha: string | null;
+    afterSha: string | null;
+}
+export interface NormalizedPullRequestCreateEvent extends NormalizedEventBase {
+    type: 'pull_request_create';
+    pullRequest: NormalizedPullRequest;
+}
+export interface NormalizedPullRequestEditEvent extends NormalizedEventBase {
+    type: 'pull_request_edit';
+    pullRequest: NormalizedPullRequest;
+}
+export interface NormalizedPRReviewEvent extends NormalizedEventBase {
+    type: 'pull_request_review';
+    pullRequest: NormalizedPullRequest;
+    state: ReviewState;
+    body: string | null;
+    url?: string;
+    reviewedAt: string;
+    reviewer: NormalizedActor;
+}
+export interface NormalizedPullRequestCloseEvent extends NormalizedEventBase {
+    type: 'pull_request_close';
+    pullRequest: NormalizedPullRequest;
+    closedAt: string;
+}
+export interface NormalizedPullRequestMergeEvent extends NormalizedEventBase {
+    type: 'pull_request_merge';
+    pullRequest: NormalizedPullRequest;
+    mergedAt: string;
+    mergeCommitSha?: string;
+}
+export {};

package/dist/types/events.js

@@ -0,0 +1,14 @@
+"use strict";
+/*
+Normalized types for the Git SDK.
+
+These types are used to normalize the data from the git providers
+into a format that is easy to use in the Git SDK.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReviewStateValues = void 0;
+exports.ReviewStateValues = {
+    APPROVED: 'APPROVED',
+    CHANGES_REQUESTED: 'CHANGES_REQUESTED',
+};
+//# sourceMappingURL=events.js.map

package/dist/types/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/types/events.ts"],"names":[],"mappings":";AAAA;;;;;EAKE;;;AAKW,QAAA,iBAAiB,GAAG;IAC/B,QAAQ,EAAE,UAAU;IACpB,iBAAiB,EAAE,mBAAmB;CAC9B,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Type exports for the Git SDK.
+ */
+export * from './provider';
+export * from './config';
+export * from './types';
+export * from './events';

package/dist/types/index.js

@@ -0,0 +1,24 @@
+"use strict";
+/**
+ * Type exports for the Git SDK.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./provider"), exports);
+__exportStar(require("./config"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./events"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;AAEH,6CAA2B;AAC3B,2CAAyB;AACzB,0CAAwB;AACxB,2CAAyB"}

package/dist/types/provider.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Provider-related types for the Git SDK.
+ */
+/**
+ * Context passed to provider adapter methods that require API authentication.
+ */
+export interface ProviderContext {
+    /** Provider API token (e.g., GitHub PAT, GitLab access token) */
+    token: string;
+    /** Optional base URL for enterprise instances */
+    baseUrl?: string;
+}
+export declare const GitProviderValues: {
+    readonly UNKNOWN: "unknown";
+    readonly GITHUB: "github";
+    readonly GITLAB: "gitlab";
+    readonly BITBUCKET: "bitbucket";
+    readonly AZURE: "azure";
+};
+export type GitProvider = (typeof GitProviderValues)[keyof typeof GitProviderValues];

package/dist/types/provider.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * Provider-related types for the Git SDK.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GitProviderValues = void 0;
+exports.GitProviderValues = {
+    UNKNOWN: 'unknown',
+    GITHUB: 'github',
+    GITLAB: 'gitlab',
+    BITBUCKET: 'bitbucket',
+    AZURE: 'azure',
+};
+//# sourceMappingURL=provider.js.map

package/dist/types/provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.js","sourceRoot":"","sources":["../../src/types/provider.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAaU,QAAA,iBAAiB,GAAG;IAC/B,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;IACtB,KAAK,EAAE,OAAO;CACN,CAAC"}

package/dist/types/types.d.ts

@@ -0,0 +1,48 @@
+import { GitProvider } from './provider';
+export interface NormalizedActor {
+    external_id?: string;
+    username?: string;
+    url?: string;
+    email?: string;
+}
+export interface NormalizedCommit {
+    sha: string;
+    message: string;
+    url: string;
+    timestamp: string;
+}
+export interface NormalizedBranch {
+    name: string;
+}
+export interface NormalizedPullRequest {
+    id: string;
+    number: number;
+    title: string;
+    body: string | null;
+    url: string;
+    isDraft: boolean;
+    sourceBranch: NormalizedBranch;
+    targetBranch: NormalizedBranch;
+    sourceRepo?: NormalizedRepository;
+    createdAt: string;
+    updatedAt: string;
+    author: NormalizedActor;
+}
+export interface NormalizedRepository {
+    name: string;
+    id: string;
+    url: string;
+    provider: GitProvider;
+}
+/**
+ * Diff statistics for a pull request.
+ * Populated after merge to capture the final size of the change.
+ */
+export interface NormalizedDiffStats {
+    /** Total lines added across all files */
+    lines_added: number;
+    /** Total lines deleted across all files */
+    lines_deleted: number;
+    /** Total number of files changed */
+    files_changed: number;
+}

package/dist/types/types.js

@@ -0,0 +1,9 @@
+"use strict";
+/*
+Normalized types for the Git SDK.
+
+These types are used to normalize the data from the git providers
+into a format that is easy to use in the Git SDK.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types/types.js.map

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

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@devrev/git-sdk",
+  "version": "0.11.0",
+  "description": "Git SDK containing adapter interfaces for git connectors to publish events from GitHub, GitLab, etc. into DevRev",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "lint": "eslint --ignore-path .gitignore .",
+    "lint:fix": "eslint --fix --ignore-path .gitignore .",
+    "build": "rimraf ./dist && tsc",
+    "build:watch": "tsc --watch",
+    "start": "ts-node ./src/index.ts",
+    "start:watch": "nodemon ./src/index.ts",
+    "test": "jest --detectOpenHandles",
+    "test:watch": "jest --detectOpenHandles --watch",
+    "clean": "rimraf ./dist"
+  },
+  "keywords": [],
+  "author": "devrev",
+  "license": "ISC",
+  "dependencies": {
+    "@devrev/typescript-sdk": "^1.1.70",
+    "axios": "^1.13.5"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.20.12",
+    "@babel/preset-env": "^7.21.5",
+    "@babel/preset-typescript": "^7.18.6",
+    "@types/jest": "^29.4.0",
+    "@types/node": "^18.13.0",
+    "@typescript-eslint/eslint-plugin": "^5.51.0",
+    "@typescript-eslint/parser": "^5.51.0",
+    "babel-jest": "^29.4.2",
+    "eslint": "^8.33.0",
+    "eslint-config-airbnb-typescript": "^17.0.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.5.0",
+    "nodemon": "^3.1.10",
+    "prettier": "2.8.4",
+    "rimraf": "^4.1.2",
+    "ts-jest": "^29.0.5",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/devrev/git-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/devrev/git-sdk/issues"
+  },
+  "homepage": "https://github.com/devrev/git-sdk#git-sdk",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "files": [
+    "dist"
+  ]
+}