@bernierllc/github-parser 1.0.0

package/dist/github-parser.d.ts

@@ -0,0 +1,46 @@
+import type { GitHubWebhookPayload, ParsedWebhookEvent, ParsedCommit, ParsedRepository } from './types';
+/**
+ * GitHub webhook payload parser
+ */
+export declare class GitHubParser {
+    /**
+     * Parse GitHub webhook payload
+     */
+    parse(payload: GitHubWebhookPayload): ParsedWebhookEvent;
+    /**
+     * Extract commits from push webhook
+     */
+    extractCommits(payload: GitHubWebhookPayload): ParsedCommit[];
+    /**
+     * Extract single commit
+     */
+    extractCommit(payload: GitHubWebhookPayload): ParsedCommit | null;
+    /**
+     * Parse commit object
+     */
+    private parseCommit;
+    /**
+     * Extract repository information
+     */
+    extractRepository(payload: GitHubWebhookPayload): ParsedRepository;
+    /**
+     * Normalize event type
+     */
+    normalizeEventType(payload: GitHubWebhookPayload): string;
+    /**
+     * Extract action (for pull_request, issues, etc.)
+     */
+    private extractAction;
+    /**
+     * Extract branch name
+     */
+    private extractBranch;
+    /**
+     * Extract git ref
+     */
+    private extractRef;
+    /**
+     * Extract sender information
+     */
+    private extractSender;
+}

package/dist/github-parser.js

@@ -0,0 +1,192 @@
+"use strict";
+/*
+Copyright (c) 2025 Bernier LLC
+
+This file is licensed to the client under a limited-use license.
+The client may use and modify this code *only within the scope of the project it was delivered for*.
+Redistribution or use in other products or commercial offerings is not permitted without written consent from Bernier LLC.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GitHubParser = void 0;
+const logger_1 = require("@bernierllc/logger");
+const logger = (0, logger_1.createLogger)();
+/**
+ * GitHub webhook payload parser
+ */
+class GitHubParser {
+    /**
+     * Parse GitHub webhook payload
+     */
+    parse(payload) {
+        const eventType = this.normalizeEventType(payload);
+        const repository = this.extractRepository(payload);
+        const parsed = {
+            type: eventType,
+            repository,
+            action: this.extractAction(payload),
+            branch: this.extractBranch(payload),
+            ref: this.extractRef(payload),
+            sender: this.extractSender(payload)
+        };
+        // Extract commits based on event type
+        if (eventType === 'push') {
+            parsed.commits = this.extractCommits(payload);
+        }
+        else {
+            const commit = this.extractCommit(payload);
+            if (commit) {
+                parsed.commit = commit;
+            }
+        }
+        logger.debug('Parsed GitHub webhook', { eventType, repository: repository.fullName });
+        return parsed;
+    }
+    /**
+     * Extract commits from push webhook
+     */
+    extractCommits(payload) {
+        const commits = payload.commits || [];
+        return commits.map((commit) => this.parseCommit(commit));
+    }
+    /**
+     * Extract single commit
+     */
+    extractCommit(payload) {
+        const commit = payload.commit;
+        if (!commit) {
+            return null;
+        }
+        return this.parseCommit(commit);
+    }
+    /**
+     * Parse commit object
+     */
+    parseCommit(commit) {
+        const author = commit.author;
+        const committer = commit.committer;
+        // Parse additions and deletions - can be arrays or numbers
+        let additions = 0;
+        let deletions = 0;
+        if (Array.isArray(commit.added)) {
+            additions = commit.added.length;
+        }
+        else if (typeof commit.additions === 'number') {
+            additions = commit.additions;
+        }
+        if (Array.isArray(commit.removed)) {
+            deletions = commit.removed.length;
+        }
+        else if (typeof commit.deletions === 'number') {
+            deletions = commit.deletions;
+        }
+        return {
+            sha: String(commit.sha || commit.id || ''),
+            message: String(commit.message || ''),
+            author: {
+                name: String(author?.name || committer?.name || ''),
+                email: String(author?.email || committer?.email || ''),
+                username: author?.username ? String(author.username) : undefined
+            },
+            timestamp: commit.timestamp
+                ? new Date(String(commit.timestamp))
+                : new Date(),
+            url: String(commit.url || ''),
+            additions,
+            deletions,
+            files: commit.modified || []
+        };
+    }
+    /**
+     * Extract repository information
+     */
+    extractRepository(payload) {
+        const repo = payload.repository;
+        if (!repo) {
+            throw new Error('Repository information not found in payload');
+        }
+        const owner = repo.owner;
+        return {
+            id: Number(repo.id || 0),
+            name: String(repo.name || ''),
+            fullName: String(repo.full_name || repo.fullName || ''),
+            owner: {
+                login: String(owner?.login || ''),
+                type: String(owner?.type || 'User')
+            },
+            defaultBranch: String(repo.default_branch || repo.defaultBranch || 'main'),
+            url: String(repo.html_url || repo.htmlUrl || repo.url || ''),
+            private: Boolean(repo.private)
+        };
+    }
+    /**
+     * Normalize event type
+     */
+    normalizeEventType(payload) {
+        // Check X-GitHub-Event header or payload field
+        const eventType = payload['X-GitHub-Event'] ||
+            payload.action ||
+            payload.type;
+        // If we have an explicit event type, normalize it
+        if (eventType) {
+            if (eventType.includes('push'))
+                return 'push';
+            if (eventType.includes('pull_request'))
+                return 'pull_request';
+            if (eventType.includes('issue'))
+                return 'issues';
+            if (eventType.includes('release'))
+                return 'release';
+            return eventType.toLowerCase();
+        }
+        // Infer event type from payload structure
+        if (payload.ref && typeof payload.ref === 'string' && payload.ref.startsWith('refs/heads/')) {
+            return 'push';
+        }
+        if (payload.pull_request) {
+            return 'pull_request';
+        }
+        if (payload.issue) {
+            return 'issues';
+        }
+        if (payload.release) {
+            return 'release';
+        }
+        return 'unknown';
+    }
+    /**
+     * Extract action (for pull_request, issues, etc.)
+     */
+    extractAction(payload) {
+        return payload.action;
+    }
+    /**
+     * Extract branch name
+     */
+    extractBranch(payload) {
+        const ref = this.extractRef(payload);
+        if (!ref)
+            return undefined;
+        // Extract branch from ref (e.g., "refs/heads/main" -> "main")
+        const match = ref.match(/^refs\/heads\/(.+)$/);
+        return match ? match[1] : ref;
+    }
+    /**
+     * Extract git ref
+     */
+    extractRef(payload) {
+        return payload.ref || undefined;
+    }
+    /**
+     * Extract sender information
+     */
+    extractSender(payload) {
+        const sender = payload.sender;
+        if (!sender)
+            return undefined;
+        return {
+            login: String(sender.login || ''),
+            type: String(sender.type || 'User')
+        };
+    }
+}
+exports.GitHubParser = GitHubParser;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { GitHubParser } from './github-parser';
+export type { GitHubWebhookPayload, ParsedWebhookEvent, ParsedCommit, ParsedRepository } from './types';

package/dist/index.js

@@ -0,0 +1,12 @@
+"use strict";
+/*
+Copyright (c) 2025 Bernier LLC
+
+This file is licensed to the client under a limited-use license.
+The client may use and modify this code *only within the scope of the project it was delivered for*.
+Redistribution or use in other products or commercial offerings is not permitted without written consent from Bernier LLC.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GitHubParser = void 0;
+var github_parser_1 = require("./github-parser");
+Object.defineProperty(exports, "GitHubParser", { enumerable: true, get: function () { return github_parser_1.GitHubParser; } });

package/dist/types.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Raw GitHub webhook payload
+ */
+export interface GitHubWebhookPayload {
+    [key: string]: unknown;
+}
+/**
+ * Parsed commit information
+ */
+export interface ParsedCommit {
+    /** Commit SHA */
+    sha: string;
+    /** Commit message */
+    message: string;
+    /** Commit author */
+    author: {
+        name: string;
+        email: string;
+        username?: string;
+    };
+    /** Commit timestamp */
+    timestamp: Date;
+    /** Commit URL */
+    url: string;
+    /** Lines added */
+    additions: number;
+    /** Lines deleted */
+    deletions: number;
+    /** Files changed */
+    files: string[];
+}
+/**
+ * Parsed repository information
+ */
+export interface ParsedRepository {
+    /** Repository ID */
+    id: number;
+    /** Repository name */
+    name: string;
+    /** Full repository name (owner/repo) */
+    fullName: string;
+    /** Repository owner */
+    owner: {
+        login: string;
+        type: string;
+    };
+    /** Default branch */
+    defaultBranch: string;
+    /** Repository URL */
+    url: string;
+    /** Whether repository is private */
+    private: boolean;
+}
+/**
+ * Parsed webhook event
+ */
+export interface ParsedWebhookEvent {
+    /** Event type */
+    type: 'push' | 'pull_request' | 'issues' | 'release' | string;
+    /** Event action (for pull_request, issues, etc.) */
+    action?: string;
+    /** Repository information */
+    repository: ParsedRepository;
+    /** Commits (for push events) */
+    commits?: ParsedCommit[];
+    /** Single commit (for some events) */
+    commit?: ParsedCommit;
+    /** Branch name */
+    branch?: string;
+    /** Git ref */
+    ref?: string;
+    /** Event sender */
+    sender?: {
+        login: string;
+        type: string;
+    };
+}

package/dist/types.js

@@ -0,0 +1,9 @@
+"use strict";
+/*
+Copyright (c) 2025 Bernier LLC
+
+This file is licensed to the client under a limited-use license.
+The client may use and modify this code *only within the scope of the project it was delivered for*.
+Redistribution or use in other products or commercial offerings is not permitted without written consent from Bernier LLC.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });

package/jest.config.cjs

@@ -0,0 +1,30 @@
+/*
+Copyright (c) 2025 Bernier LLC
+
+This file is licensed to the client under a limited-use license.
+The client may use and modify this code *only within the scope of the project it was delivered for*.
+Redistribution or use in other products or commercial offerings is not permitted without written consent from Bernier LLC.
+*/
+
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: '<rootDir>/../../../jest-environment-node-fixed.cjs',
+  roots: ['<rootDir>/__tests__'],
+  testMatch: ['**/*.test.ts'],
+  collectCoverageFrom: [
+    'src/**/*.ts',
+    '!src/**/*.d.ts',
+    '!src/index.ts'
+  ],
+  coverageThreshold: {
+    global: {
+      branches: 90,
+      functions: 90,
+      lines: 90,
+      statements: 90
+    }
+  },
+  coverageDirectory: 'coverage',
+  verbose: true
+};
+

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@bernierllc/github-parser",
+  "version": "1.0.0",
+  "description": "GitHub webhook payload parser and transformer",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "keywords": [
+    "github",
+    "webhook",
+    "parser",
+    "git"
+  ],
+  "author": "Bernier LLC",
+  "license": "SEE LICENSE IN LICENSE",
+  "dependencies": {
+    "@bernierllc/logger": "1.0.3"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.0",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.0.0",
+    "jest": "^29.5.0",
+    "rimraf": "^5.0.0",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "jest",
+    "test:run": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "lint": "eslint src --ext .ts",
+    "clean": "rimraf dist"
+  }
+}

package/src/github-parser.ts

@@ -0,0 +1,213 @@
+/*
+Copyright (c) 2025 Bernier LLC
+
+This file is licensed to the client under a limited-use license.
+The client may use and modify this code *only within the scope of the project it was delivered for*.
+Redistribution or use in other products or commercial offerings is not permitted without written consent from Bernier LLC.
+*/
+
+import { createLogger } from '@bernierllc/logger';
+import type {
+  GitHubWebhookPayload,
+  ParsedWebhookEvent,
+  ParsedCommit,
+  ParsedRepository
+} from './types';
+
+const logger = createLogger();
+
+/**
+ * GitHub webhook payload parser
+ */
+export class GitHubParser {
+  /**
+   * Parse GitHub webhook payload
+   */
+  parse(payload: GitHubWebhookPayload): ParsedWebhookEvent {
+    const eventType = this.normalizeEventType(payload);
+    const repository = this.extractRepository(payload);
+
+    const parsed: ParsedWebhookEvent = {
+      type: eventType,
+      repository,
+      action: this.extractAction(payload),
+      branch: this.extractBranch(payload),
+      ref: this.extractRef(payload),
+      sender: this.extractSender(payload)
+    };
+
+    // Extract commits based on event type
+    if (eventType === 'push') {
+      parsed.commits = this.extractCommits(payload);
+    } else {
+      const commit = this.extractCommit(payload);
+      if (commit) {
+        parsed.commit = commit;
+      }
+    }
+
+    logger.debug('Parsed GitHub webhook', { eventType, repository: repository.fullName });
+
+    return parsed;
+  }
+
+  /**
+   * Extract commits from push webhook
+   */
+  extractCommits(payload: GitHubWebhookPayload): ParsedCommit[] {
+    const commits = (payload.commits as unknown[]) || [];
+    return commits.map((commit: unknown) => this.parseCommit(commit as Record<string, unknown>));
+  }
+
+  /**
+   * Extract single commit
+   */
+  extractCommit(payload: GitHubWebhookPayload): ParsedCommit | null {
+    const commit = payload.commit as Record<string, unknown> | undefined;
+    if (!commit) {
+      return null;
+    }
+    return this.parseCommit(commit);
+  }
+
+  /**
+   * Parse commit object
+   */
+  private parseCommit(commit: Record<string, unknown>): ParsedCommit {
+    const author = commit.author as Record<string, unknown> | undefined;
+    const committer = commit.committer as Record<string, unknown> | undefined;
+
+    // Parse additions and deletions - can be arrays or numbers
+    let additions = 0;
+    let deletions = 0;
+
+    if (Array.isArray(commit.added)) {
+      additions = commit.added.length;
+    } else if (typeof commit.additions === 'number') {
+      additions = commit.additions;
+    }
+
+    if (Array.isArray(commit.removed)) {
+      deletions = commit.removed.length;
+    } else if (typeof commit.deletions === 'number') {
+      deletions = commit.deletions;
+    }
+
+    return {
+      sha: String(commit.sha || commit.id || ''),
+      message: String(commit.message || ''),
+      author: {
+        name: String(author?.name || committer?.name || ''),
+        email: String(author?.email || committer?.email || ''),
+        username: author?.username ? String(author.username) : undefined
+      },
+      timestamp: commit.timestamp
+        ? new Date(String(commit.timestamp))
+        : new Date(),
+      url: String(commit.url || ''),
+      additions,
+      deletions,
+      files: (commit.modified as string[]) || []
+    };
+  }
+
+  /**
+   * Extract repository information
+   */
+  extractRepository(payload: GitHubWebhookPayload): ParsedRepository {
+    const repo = payload.repository as Record<string, unknown> | undefined;
+    if (!repo) {
+      throw new Error('Repository information not found in payload');
+    }
+
+    const owner = repo.owner as Record<string, unknown> | undefined;
+
+    return {
+      id: Number(repo.id || 0),
+      name: String(repo.name || ''),
+      fullName: String(repo.full_name || repo.fullName || ''),
+      owner: {
+        login: String(owner?.login || ''),
+        type: String(owner?.type || 'User')
+      },
+      defaultBranch: String(repo.default_branch || repo.defaultBranch || 'main'),
+      url: String(repo.html_url || repo.htmlUrl || repo.url || ''),
+      private: Boolean(repo.private)
+    };
+  }
+
+  /**
+   * Normalize event type
+   */
+  normalizeEventType(payload: GitHubWebhookPayload): string {
+    // Check X-GitHub-Event header or payload field
+    const eventType = (payload['X-GitHub-Event'] as string) ||
+                     (payload.action as string) ||
+                     (payload.type as string);
+
+    // If we have an explicit event type, normalize it
+    if (eventType) {
+      if (eventType.includes('push')) return 'push';
+      if (eventType.includes('pull_request')) return 'pull_request';
+      if (eventType.includes('issue')) return 'issues';
+      if (eventType.includes('release')) return 'release';
+      return eventType.toLowerCase();
+    }
+
+    // Infer event type from payload structure
+    if (payload.ref && typeof payload.ref === 'string' && payload.ref.startsWith('refs/heads/')) {
+      return 'push';
+    }
+    if (payload.pull_request) {
+      return 'pull_request';
+    }
+    if (payload.issue) {
+      return 'issues';
+    }
+    if (payload.release) {
+      return 'release';
+    }
+
+    return 'unknown';
+  }
+
+  /**
+   * Extract action (for pull_request, issues, etc.)
+   */
+  private extractAction(payload: GitHubWebhookPayload): string | undefined {
+    return payload.action as string | undefined;
+  }
+
+  /**
+   * Extract branch name
+   */
+  private extractBranch(payload: GitHubWebhookPayload): string | undefined {
+    const ref = this.extractRef(payload);
+    if (!ref) return undefined;
+
+    // Extract branch from ref (e.g., "refs/heads/main" -> "main")
+    const match = ref.match(/^refs\/heads\/(.+)$/);
+    return match ? match[1] : ref;
+  }
+
+  /**
+   * Extract git ref
+   */
+  private extractRef(payload: GitHubWebhookPayload): string | undefined {
+    return (payload.ref as string) || undefined;
+  }
+
+  /**
+   * Extract sender information
+   */
+  private extractSender(payload: GitHubWebhookPayload): { login: string; type: string } | undefined {
+    const sender = payload.sender as Record<string, unknown> | undefined;
+    if (!sender) return undefined;
+
+    return {
+      login: String(sender.login || ''),
+      type: String(sender.type || 'User')
+    };
+  }
+}
+

package/src/index.ts

@@ -0,0 +1,16 @@
+/*
+Copyright (c) 2025 Bernier LLC
+
+This file is licensed to the client under a limited-use license.
+The client may use and modify this code *only within the scope of the project it was delivered for*.
+Redistribution or use in other products or commercial offerings is not permitted without written consent from Bernier LLC.
+*/
+
+export { GitHubParser } from './github-parser';
+export type {
+  GitHubWebhookPayload,
+  ParsedWebhookEvent,
+  ParsedCommit,
+  ParsedRepository
+} from './types';
+