@elizaos/plugin-github 1.2.0 → 1.2.9

package/dist/index.d.ts

@@ -1,9 +1,563 @@
-import type { Plugin } from '@elizaos/core';
-import { type Action, type Provider } from '@elizaos/core';
-import { GitHubService } from './services/github';
+import { Service, IAgentRuntime, Action, Provider, Plugin } from '@elizaos/core';
+import { z } from 'zod';
+
+interface GitHubActivityItem$1 {
+    id: string;
+    timestamp: string;
+    action: string;
+    resource_type: "repository" | "issue" | "pr" | "user";
+    resource_id: string;
+    details: Record<string, any>;
+    success: boolean;
+    error?: string;
+}
+declare class GitHubService extends Service {
+    static serviceType: string;
+    capabilityDescription: string;
+    private octokit;
+    private rateLimitRemaining;
+    private rateLimitReset;
+    private activityLog;
+    private githubConfig;
+    constructor(runtime?: IAgentRuntime);
+    static start(runtime: IAgentRuntime): Promise<GitHubService>;
+    stop(): Promise<void>;
+    /**
+     * Validate authentication by checking user permissions
+     */
+    validateAuthentication(): Promise<boolean>;
+    /**
+     * Rate limiting helper to prevent hitting GitHub API limits
+     */
+    private checkRateLimit;
+    /**
+     * Update rate limit info from response headers
+     */
+    private updateRateLimit;
+    /**
+     * Sanitize error for logging (remove sensitive data)
+     */
+    private sanitizeError;
+    /**
+     * Validate GitHub username/repo name format
+     */
+    private validateGitHubName;
+    /**
+     * Get authenticated user information
+     */
+    getAuthenticatedUser(): Promise<any>;
+    /**
+     * Get user by username
+     */
+    getUserByUsername(username: string): Promise<any>;
+    /**
+     * Get repository information
+     */
+    getRepository(owner: string, repo: string): Promise<any>;
+    /**
+     * List repositories for authenticated user
+     */
+    getRepositories(options?: {
+        visibility?: "all" | "public" | "private";
+        affiliation?: "owner" | "collaborator" | "organization_member";
+        type?: "all" | "owner" | "public" | "private" | "member";
+        sort?: "created" | "updated" | "pushed" | "full_name";
+        direction?: "asc" | "desc";
+        per_page?: number;
+    }): Promise<any>;
+    /**
+     * Get repository issues
+     */
+    getRepositoryIssues(owner: string, repo: string, options?: {
+        milestone?: string | number;
+        state?: "open" | "closed" | "all";
+        assignee?: string;
+        creator?: string;
+        mentioned?: string;
+        labels?: string;
+        sort?: "created" | "updated" | "comments";
+        direction?: "asc" | "desc";
+        since?: string;
+        per_page?: number;
+    }): Promise<any>;
+    /**
+     * Get specific issue
+     */
+    getIssue(owner: string, repo: string, issue_number: number): Promise<any>;
+    /**
+     * Create issue comment
+     */
+    createIssueComment(owner: string, repo: string, issue_number: number, body: string): Promise<any>;
+    /**
+     * Get issue comments
+     */
+    getIssueComments(owner: string, repo: string, issue_number: number, options?: {
+        since?: string;
+        per_page?: number;
+    }): Promise<any>;
+    /**
+     * Get repository pull requests
+     */
+    getRepositoryPullRequests(owner: string, repo: string, options?: {
+        state?: "open" | "closed" | "all";
+        head?: string;
+        base?: string;
+        sort?: "created" | "updated" | "popularity";
+        direction?: "asc" | "desc";
+        per_page?: number;
+    }): Promise<any>;
+    /**
+     * Get specific pull request
+     */
+    getPullRequest(owner: string, repo: string, pull_number: number): Promise<any>;
+    /**
+     * Create pull request
+     */
+    createPullRequest(owner: string, repo: string, options: {
+        title: string;
+        head: string;
+        base: string;
+        body?: string;
+        maintainer_can_modify?: boolean;
+        draft?: boolean;
+    }): Promise<any>;
+    /**
+     * Create or update file
+     */
+    createOrUpdateFile(owner: string, repo: string, path: string, content: string, message: string, branch?: string, sha?: string): Promise<any>;
+    /**
+     * Get file content
+     */
+    getFileContent(owner: string, repo: string, path: string, ref?: string): Promise<{
+        content: string;
+        sha: string;
+    }>;
+    /**
+     * Delete file
+     */
+    deleteFile(owner: string, repo: string, path: string, message: string, sha: string, branch?: string): Promise<any>;
+    /**
+     * Get repository tree
+     */
+    getRepositoryTree(owner: string, repo: string, tree_sha?: string): Promise<any[]>;
+    /**
+     * Get default branch
+     */
+    getDefaultBranch(owner: string, repo: string): Promise<string>;
+    /**
+     * Create webhook
+     */
+    createWebhook(owner: string, repo: string, config: {
+        url: string;
+        content_type?: "json" | "form";
+        secret?: string;
+        insecure_ssl?: string;
+    }, events?: string[]): Promise<any>;
+    /**
+     * List webhooks
+     */
+    listWebhooks(owner: string, repo: string): Promise<any[]>;
+    /**
+     * Delete webhook
+     */
+    deleteWebhook(owner: string, repo: string, hook_id: number): Promise<void>;
+    /**
+     * Ping webhook
+     */
+    pingWebhook(owner: string, repo: string, hook_id: number): Promise<void>;
+    /**
+     * Get activity log for debugging and monitoring
+     */
+    getActivityLog(limit?: number): GitHubActivityItem$1[];
+    /**
+     * Clear activity log
+     */
+    clearActivityLog(): void;
+    /**
+     * Get rate limit status
+     */
+    getRateLimitStatus(): {
+        remaining: number;
+        reset: number;
+        limit: number;
+        used: number;
+        resource: string;
+    };
+    /**
+     * Get rate limit (alias for compatibility)
+     */
+    getRateLimit(): {
+        remaining: number;
+        reset: number;
+        limit: number;
+        used: number;
+        resource: string;
+    };
+    /**
+     * Get current authenticated user (alias for compatibility)
+     */
+    getCurrentUser(): Promise<any>;
+    /**
+     * Get Git reference
+     */
+    getRef(owner: string, repo: string, ref: string): Promise<any>;
+    /**
+     * Create a new branch
+     */
+    createBranch(owner: string, repo: string, branchName: string, sha: string): Promise<any>;
+    /**
+     * List branches
+     */
+    listBranches(owner: string, repo: string): Promise<any[]>;
+    /**
+     * Get branch details
+     */
+    getBranch(owner: string, repo: string, branch: string): Promise<any>;
+    /**
+     * Delete a branch
+     */
+    deleteBranch(owner: string, repo: string, branch: string): Promise<void>;
+    /**
+     * Compare two branches
+     */
+    compareBranches(owner: string, repo: string, base: string, head: string): Promise<any>;
+    /**
+     * Get branch protection settings
+     */
+    getBranchProtection(owner: string, repo: string, branch: string): Promise<any>;
+    /**
+     * List issues
+     */
+    listIssues(owner: string, repo: string, options?: any): Promise<any>;
+    /**
+     * Create issue
+     */
+    createIssue(owner: string, repo: string, options: {
+        title: string;
+        body?: string;
+        assignees?: string[];
+        milestone?: number;
+        labels?: string[];
+    }): Promise<any>;
+    /**
+     * Search issues
+     */
+    searchIssues(query: string, options?: any): Promise<any>;
+    /**
+     * Search pull requests
+     */
+    searchPullRequests(query: string, options?: any): Promise<any>;
+    /**
+     * List pull requests
+     */
+    listPullRequests(owner: string, repo: string, options?: any): Promise<any>;
+    /**
+     * Merge pull request
+     */
+    mergePullRequest(owner: string, repo: string, pull_number: number, options?: {
+        commit_title?: string;
+        commit_message?: string;
+        merge_method?: "merge" | "squash" | "rebase";
+    }): Promise<any>;
+    /**
+     * List repositories
+     */
+    listRepositories(options?: any): Promise<any>;
+    /**
+     * Create repository
+     */
+    createRepository(options: {
+        name: string;
+        description?: string;
+        private?: boolean;
+        auto_init?: boolean;
+        gitignore_template?: string;
+        license_template?: string;
+    }): Promise<any>;
+    /**
+     * Search repositories
+     */
+    searchRepositories(query: string, options?: any): Promise<any>;
+    /**
+     * Get contributors stats
+     */
+    getContributorsStats(owner: string, repo: string): Promise<any>;
+    /**
+     * Get commit activity stats
+     */
+    getCommitActivityStats(owner: string, repo: string): Promise<any>;
+    /**
+     * Get code frequency stats
+     */
+    getCodeFrequencyStats(owner: string, repo: string): Promise<any>;
+    /**
+     * Get repository languages
+     */
+    getLanguages(owner: string, repo: string): Promise<any>;
+    /**
+     * Get traffic views
+     */
+    getTrafficViews(owner: string, repo: string): Promise<any>;
+    /**
+     * Get traffic clones
+     */
+    getTrafficClones(owner: string, repo: string): Promise<any>;
+    /**
+     * Get top paths
+     */
+    getTopPaths(owner: string, repo: string): Promise<any>;
+    /**
+     * Get top referrers
+     */
+    getTopReferrers(owner: string, repo: string): Promise<any>;
+    /**
+     * Get user information
+     */
+    getUser(username: string): Promise<any>;
+    /**
+     * List user repositories
+     */
+    listUserRepositories(username: string, options?: any): Promise<any>;
+    /**
+     * List user events
+     */
+    listUserEvents(username: string, options?: any): Promise<any>;
+    private logActivity;
+    private handleError;
+}
+
+declare const githubConfigSchema: z.ZodObject<{
+    GITHUB_TOKEN: z.ZodString;
+    GITHUB_OWNER: z.ZodOptional<z.ZodString>;
+    GITHUB_WEBHOOK_SECRET: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const githubConfigSchemaFlexible: z.ZodObject<{
+    GITHUB_TOKEN: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodUndefined]>>>;
+    GITHUB_OWNER: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodUndefined]>>>;
+    GITHUB_WEBHOOK_SECRET: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodUndefined]>>>;
+}, z.core.$strip>;
+type GitHubConfig = z.infer<typeof githubConfigSchema>;
+interface GitHubRepository {
+    id: number;
+    name: string;
+    full_name: string;
+    description: string | null;
+    html_url: string;
+    clone_url: string;
+    ssh_url: string;
+    private: boolean;
+    fork: boolean;
+    archived: boolean;
+    disabled: boolean;
+    created_at: string;
+    updated_at: string;
+    pushed_at: string;
+    size: number;
+    stargazers_count: number;
+    watchers_count: number;
+    forks_count: number;
+    open_issues_count: number;
+    language: string | null;
+    topics: string[];
+    license: {
+        key: string;
+        name: string;
+        spdx_id: string;
+    } | null;
+    default_branch: string;
+    owner: {
+        login: string;
+        id: number;
+        type: "User" | "Organization";
+        avatar_url: string;
+    };
+}
+interface GitHubIssue {
+    id: number;
+    number: number;
+    title: string;
+    body: string | null;
+    state: "open" | "closed";
+    labels: Array<{
+        id: number;
+        name: string;
+        color: string;
+        description: string | null;
+    }>;
+    assignees: Array<{
+        login: string;
+        id: number;
+        avatar_url: string;
+    }>;
+    user: {
+        login: string;
+        id: number;
+        avatar_url: string;
+    };
+    created_at: string;
+    updated_at: string;
+    closed_at: string | null;
+    html_url: string;
+    comments: number;
+    milestone: {
+        id: number;
+        title: string;
+        description: string | null;
+        state: "open" | "closed";
+        due_on: string | null;
+    } | null;
+}
+interface GitHubPullRequest {
+    id: number;
+    number: number;
+    title: string;
+    body: string | null;
+    state: "open" | "closed" | "merged";
+    draft: boolean;
+    merged: boolean;
+    mergeable: boolean | null;
+    merged_at: string | null;
+    head: {
+        ref: string;
+        sha: string;
+        repo: GitHubRepository | null;
+    };
+    base: {
+        ref: string;
+        sha: string;
+        repo: GitHubRepository;
+    };
+    user: {
+        login: string;
+        id: number;
+        avatar_url: string;
+    };
+    assignees: Array<{
+        login: string;
+        id: number;
+        avatar_url: string;
+    }>;
+    labels: Array<{
+        id: number;
+        name: string;
+        color: string;
+        description: string | null;
+    }>;
+    created_at: string;
+    updated_at: string;
+    html_url: string;
+    comments: number;
+    commits: number;
+    additions: number;
+    deletions: number;
+    changed_files: number;
+}
+interface CreateRepositoryOptions {
+    name: string;
+    description?: string;
+    private?: boolean;
+    auto_init?: boolean;
+    gitignore_template?: string;
+    license_template?: string;
+    allow_squash_merge?: boolean;
+    allow_merge_commit?: boolean;
+    allow_rebase_merge?: boolean;
+    delete_branch_on_merge?: boolean;
+    has_issues?: boolean;
+    has_projects?: boolean;
+    has_wiki?: boolean;
+    has_downloads?: boolean;
+    homepage?: string;
+    topics?: string[];
+}
+interface CreateIssueOptions {
+    title: string;
+    body?: string;
+    assignees?: string[];
+    milestone?: number;
+    labels?: string[];
+}
+interface CreatePullRequestOptions {
+    title: string;
+    head: string;
+    base: string;
+    body?: string;
+    draft?: boolean;
+    maintainer_can_modify?: boolean;
+}
+interface GitHubActivityItem {
+    id: string;
+    timestamp: string;
+    action: string;
+    resource_type: "repository" | "issue" | "pull_request";
+    resource_id: string;
+    details: Record<string, any>;
+    success: boolean;
+    error?: string;
+}
+interface GitHubSearchResult<T> {
+    total_count: number;
+    incomplete_results: boolean;
+    items: T[];
+}
+interface GitHubWebhookPayload {
+    action: string;
+    repository?: GitHubRepository;
+    issue?: GitHubIssue;
+    pull_request?: GitHubPullRequest;
+    sender: {
+        login: string;
+        id: number;
+        avatar_url: string;
+    };
+}
+interface GitHubRateLimit {
+    limit: number;
+    remaining: number;
+    reset: number;
+    used: number;
+    resource: string;
+}
+declare class GitHubAPIError extends Error {
+    status: number;
+    response?: any | undefined;
+    constructor(message: string, status: number, response?: any | undefined);
+}
+declare class GitHubAuthenticationError extends GitHubAPIError {
+    constructor(message?: string);
+}
+declare class GitHubRateLimitError extends GitHubAPIError {
+    resetTime: number;
+    constructor(message: string | undefined, resetTime: number);
+}
+declare const createRepositorySchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    private: z.ZodDefault<z.ZodBoolean>;
+    auto_init: z.ZodDefault<z.ZodBoolean>;
+    gitignore_template: z.ZodOptional<z.ZodString>;
+    license_template: z.ZodOptional<z.ZodString>;
+    homepage: z.ZodOptional<z.ZodString>;
+    topics: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+declare const createIssueSchema: z.ZodObject<{
+    title: z.ZodString;
+    body: z.ZodOptional<z.ZodString>;
+    assignees: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    milestone: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+declare const createPullRequestSchema: z.ZodObject<{
+    title: z.ZodString;
+    head: z.ZodString;
+    base: z.ZodString;
+    body: z.ZodOptional<z.ZodString>;
+    draft: z.ZodDefault<z.ZodBoolean>;
+    maintainer_can_modify: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+
 declare const githubActions: Action[];
 declare const githubProviders: Provider[];
-export declare const githubPlugin: Plugin;
-export { GitHubService, githubActions, githubProviders };
-export * from './types';
-export default githubPlugin;
+declare const githubPlugin: Plugin;
+
+export { type CreateIssueOptions, type CreatePullRequestOptions, type CreateRepositoryOptions, GitHubAPIError, type GitHubActivityItem, GitHubAuthenticationError, type GitHubConfig, type GitHubIssue, type GitHubPullRequest, type GitHubRateLimit, GitHubRateLimitError, type GitHubRepository, type GitHubSearchResult, GitHubService, type GitHubWebhookPayload, createIssueSchema, createPullRequestSchema, createRepositorySchema, githubPlugin as default, githubActions, githubConfigSchema, githubConfigSchemaFlexible, githubPlugin, githubProviders };