@squidcloud/github-client 1.0.426

package/dist/connectors/github/common/src/github-types.d.ts

@@ -0,0 +1,311 @@
+import { IntegrationId } from '../../../../internal-common/src/public-types/communication.public-types';
+export interface GitHubUser {
+    id: number;
+    login: string;
+    name?: string;
+    email?: string;
+    avatar_url: string;
+    html_url: string;
+}
+export interface GitHubLabel {
+    id: number;
+    name: string;
+    color: string;
+    description?: string;
+}
+export interface GitHubMilestone {
+    id: number;
+    number: number;
+    title: string;
+    description?: string;
+    state: 'open' | 'closed';
+    due_on?: string;
+}
+export interface GitHubPullRequest {
+    id: number;
+    number: number;
+    title: string;
+    body?: string;
+    state: 'open' | 'closed';
+    html_url: string;
+    user: GitHubUser;
+    created_at: string;
+    updated_at: string;
+    closed_at?: string;
+    merged_at?: string;
+    merge_commit_sha?: string;
+    draft: boolean;
+    head: {
+        ref: string;
+        sha: string;
+        label: string;
+    };
+    base: {
+        ref: string;
+        sha: string;
+        label: string;
+    };
+    labels: Array<GitHubLabel>;
+    milestone?: GitHubMilestone;
+    assignees: Array<GitHubUser>;
+    requested_reviewers: Array<GitHubUser>;
+    merged: boolean;
+    mergeable?: boolean;
+    mergeable_state?: string;
+    additions?: number;
+    deletions?: number;
+    changed_files?: number;
+    comments?: number;
+    review_comments?: number;
+    commits?: number;
+}
+export interface GitHubPullRequestReview {
+    id: number;
+    user: GitHubUser;
+    body?: string;
+    state: 'APPROVED' | 'CHANGES_REQUESTED' | 'COMMENTED' | 'PENDING' | 'DISMISSED';
+    submitted_at: string;
+    html_url: string;
+}
+export interface GitHubComment {
+    id: number;
+    body: string;
+    user: GitHubUser;
+    created_at: string;
+    updated_at: string;
+    html_url: string;
+}
+export interface GitHubReviewComment extends GitHubComment {
+    path: string;
+    position?: number;
+    original_position?: number;
+    diff_hunk: string;
+    line?: number;
+    original_line?: number;
+    side?: 'LEFT' | 'RIGHT';
+    commit_id: string;
+    original_commit_id: string;
+}
+export interface GitHubCommit {
+    sha: string;
+    message: string;
+    author: {
+        name: string;
+        email: string;
+        date: string;
+    };
+    committer: {
+        name: string;
+        email: string;
+        date: string;
+    };
+    html_url: string;
+}
+export interface GitHubFile {
+    sha: string;
+    filename: string;
+    status: 'added' | 'removed' | 'modified' | 'renamed' | 'copied' | 'changed' | 'unchanged';
+    additions: number;
+    deletions: number;
+    changes: number;
+    patch?: string;
+    blob_url: string;
+    raw_url: string;
+    contents_url: string;
+    previous_filename?: string;
+}
+export interface GitHubCodeSearchResult {
+    total_count: number;
+    incomplete_results: boolean;
+    items: Array<GitHubCodeSearchItem>;
+}
+export interface GitHubCodeSearchItem {
+    name: string;
+    path: string;
+    sha: string;
+    url: string;
+    html_url: string;
+    repository: {
+        id: number;
+        name: string;
+        full_name: string;
+        html_url: string;
+    };
+    text_matches?: Array<{
+        object_url: string;
+        object_type: string;
+        property: string;
+        fragment: string;
+        matches: Array<{
+            text: string;
+            indices: Array<number>;
+        }>;
+    }>;
+}
+export interface GitHubFileContent {
+    name: string;
+    path: string;
+    sha: string;
+    size: number;
+    url: string;
+    html_url: string;
+    download_url: string;
+    type: 'file' | 'dir' | 'symlink' | 'submodule';
+    content?: string;
+    encoding?: string;
+}
+export interface GitHubRepository {
+    id: number;
+    name: string;
+    full_name: string;
+    description?: string;
+    html_url: string;
+    default_branch: string;
+    private: boolean;
+    owner: GitHubUser;
+}
+export interface GitHubPullRequestDetails {
+    pr: GitHubPullRequest;
+    reviews: Array<GitHubPullRequestReview>;
+    comments: Array<GitHubComment>;
+    reviewComments: Array<GitHubReviewComment>;
+    files: Array<GitHubFile>;
+    commits: Array<GitHubCommit>;
+    detailsAsString: string;
+}
+export interface GitHubSyncData {
+    integrationId: IntegrationId;
+    lastSync: Date;
+    prIdToFailureCount: Record<number, number>;
+}
+export interface GitHubWebhookPayload {
+    action: string;
+    sender: GitHubUser;
+    repository: GitHubRepository;
+    pull_request?: GitHubPullRequest;
+    comment?: GitHubComment;
+    review?: GitHubPullRequestReview;
+    installation?: {
+        id: number;
+    };
+}
+export interface GitHubPRResponse {
+    number: number;
+    title: string;
+    state: string;
+    url: string;
+    author: string;
+}
+export interface GitHubMergeResponse {
+    sha: string;
+    merged: boolean;
+    message: string;
+}
+export interface GitHubCommentResponse {
+    commentId: number;
+    url: string;
+}
+export interface GitHubReviewResponse {
+    reviewId: number;
+    state: string;
+    url: string;
+}
+export interface GitHubCodeSearchResponse {
+    totalCount: number;
+    items: Array<{
+        path: string;
+        url: string;
+        fragments: Array<string>;
+    }>;
+}
+export interface GitHubFileContentResponse {
+    path: string;
+    content: string;
+    size: number;
+    url: string;
+}
+export interface SearchGitHubPRsRequest {
+    integrationId: IntegrationId;
+    query?: string;
+    state?: 'open' | 'closed' | 'all';
+    author?: string;
+    reviewer?: string;
+    limit?: number;
+}
+export interface GetGitHubPRRequest {
+    integrationId: IntegrationId;
+    prNumber: number;
+    includeFiles?: boolean;
+    includeReviews?: boolean;
+}
+export interface ListGitHubPRsRequest {
+    integrationId: IntegrationId;
+    state?: 'open' | 'closed' | 'all';
+    limit?: number;
+}
+export interface SearchGitHubCodeRequest {
+    integrationId: IntegrationId;
+    query: string;
+    path?: string;
+    extension?: string;
+    limit?: number;
+}
+export interface GetGitHubFileRequest {
+    integrationId: IntegrationId;
+    filePath: string;
+    ref?: string;
+}
+export interface CreateGitHubPRRequest {
+    integrationId: IntegrationId;
+    title: string;
+    body?: string;
+    head: string;
+    base: string;
+    draft?: boolean;
+}
+export interface AddGitHubPRCommentRequest {
+    integrationId: IntegrationId;
+    prNumber: number;
+    body: string;
+}
+export interface AddGitHubPRReviewRequest {
+    integrationId: IntegrationId;
+    prNumber: number;
+    body?: string;
+    event: 'APPROVE' | 'REQUEST_CHANGES' | 'COMMENT';
+}
+export interface CloseGitHubPRRequest {
+    integrationId: IntegrationId;
+    prNumber: number;
+}
+export interface MergeGitHubPRRequest {
+    integrationId: IntegrationId;
+    prNumber: number;
+    commitTitle?: string;
+    commitMessage?: string;
+    mergeMethod?: 'merge' | 'squash' | 'rebase';
+}
+export interface ExtractGitHubWebhookRequest {
+    integrationId: IntegrationId;
+    rawBody: string;
+    headers: Record<string, string | undefined>;
+}
+export interface GitHubGraphQLResponse<T> {
+    data?: T;
+    errors?: Array<{
+        message: string;
+        type?: string;
+        path?: Array<string>;
+        locations?: Array<{
+            line: number;
+            column: number;
+        }>;
+    }>;
+}
+export interface GitHubConnection<T> {
+    nodes: Array<T>;
+    pageInfo: {
+        hasNextPage: boolean;
+        endCursor?: string;
+    };
+}

package/dist/connectors/github/github-client/src/github-client.d.ts

@@ -0,0 +1,94 @@
+import { Squid } from '@squidcloud/client';
+import { AddGitHubPRCommentRequest, AddGitHubPRReviewRequest, CloseGitHubPRRequest, CreateGitHubPRRequest, ExtractGitHubWebhookRequest, GetGitHubFileRequest, GetGitHubPRRequest, GitHubCommentResponse, GitHubFileContentResponse, GitHubMergeResponse, GitHubPRResponse, GitHubReviewResponse, GitHubWebhookPayload, ListGitHubPRsRequest, MergeGitHubPRRequest, SearchGitHubCodeRequest, SearchGitHubPRsRequest } from '../../common/src/github-types';
+/**
+ * Client for interacting with the GitHub connector.
+ */
+export declare class SquidGitHubClient {
+    private readonly squid;
+    private readonly integrationId;
+    /**
+     * Creates a new GitHub client instance.
+     *
+     * @param squid - Squid client instance. Provide an instance that includes the Squid API key.
+     * @param integrationId - The ID of the GitHub integration in the Squid console
+     */
+    constructor(squid: Squid, integrationId: string);
+    /**
+     * Search for pull requests in the connected GitHub repository.
+     *
+     * @param request - Search parameters (query, state, author, reviewer, limit)
+     * @returns Formatted string with matching pull requests
+     */
+    searchPullRequests(request: Omit<SearchGitHubPRsRequest, 'integrationId'>): Promise<string>;
+    /**
+     * Get detailed information about a specific pull request.
+     *
+     * @param request - Request with PR number and optional flags for files/reviews
+     * @returns Formatted string with PR details
+     */
+    getPullRequest(request: Omit<GetGitHubPRRequest, 'integrationId'>): Promise<string>;
+    /**
+     * List pull requests by state.
+     *
+     * @param request - Request with state filter and limit
+     * @returns Formatted string with pull requests
+     */
+    listPullRequests(request?: Omit<ListGitHubPRsRequest, 'integrationId'>): Promise<string>;
+    /**
+     * Search for code in the connected GitHub repository.
+     *
+     * @param request - Search parameters (query, path, extension, limit)
+     * @returns Formatted string with matching code results
+     */
+    searchCode(request: Omit<SearchGitHubCodeRequest, 'integrationId'>): Promise<string>;
+    /**
+     * Get the content of a file from the repository.
+     *
+     * @param request - Request with file path and optional ref (branch/tag/commit)
+     * @returns File content response with path, content, size, and URL
+     */
+    getFileContent(request: Omit<GetGitHubFileRequest, 'integrationId'>): Promise<GitHubFileContentResponse>;
+    /**
+     * Create a new pull request.
+     *
+     * @param request - PR creation parameters (title, head, base, body, draft)
+     * @returns Created PR response with number, title, state, url, and author
+     */
+    createPullRequest(request: Omit<CreateGitHubPRRequest, 'integrationId'>): Promise<GitHubPRResponse>;
+    /**
+     * Add a comment to a pull request.
+     *
+     * @param request - Request with PR number and comment body
+     * @returns Comment response with ID and URL
+     */
+    addPRComment(request: Omit<AddGitHubPRCommentRequest, 'integrationId'>): Promise<GitHubCommentResponse>;
+    /**
+     * Submit a review on a pull request.
+     *
+     * @param request - Request with PR number, event type, and optional body
+     * @returns Review response with ID, state, and URL
+     */
+    addPRReview(request: Omit<AddGitHubPRReviewRequest, 'integrationId'>): Promise<GitHubReviewResponse>;
+    /**
+     * Close a pull request without merging.
+     *
+     * @param request - Request with PR number
+     * @returns Closed PR response
+     */
+    closePullRequest(request: Omit<CloseGitHubPRRequest, 'integrationId'>): Promise<GitHubPRResponse>;
+    /**
+     * Merge a pull request.
+     *
+     * @param request - Request with PR number and optional merge options
+     * @returns Merge response with SHA, merged status, and message
+     */
+    mergePullRequest(request: Omit<MergeGitHubPRRequest, 'integrationId'>): Promise<GitHubMergeResponse>;
+    /**
+     * Extract and validate GitHub webhook data from an incoming request.
+     * Verifies the webhook signature if a webhook secret is configured.
+     *
+     * @param request - Request with raw body and headers from the webhook
+     * @returns Parsed and validated webhook payload
+     */
+    extractWebhookData(request: Omit<ExtractGitHubWebhookRequest, 'integrationId'>): Promise<GitHubWebhookPayload>;
+}

package/dist/connectors/github/github-client/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from '../../common/src/github-types';
+export * from './github-client';

package/dist/index.js

@@ -0,0 +1 @@
+(()=>{"use strict";var t={d:(e,i)=>{for(var n in i)t.o(i,n)&&!t.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:i[n]})},o:(t,e)=>Object.prototype.hasOwnProperty.call(t,e),r:t=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})}},e={};t.r(e),t.d(e,{SquidGitHubClient:()=>i});class i{constructor(t,e){this.squid=t,this.integrationId=e}async searchPullRequests(t){const e={...t,integrationId:this.integrationId};return this.squid.executeFunction("searchGitHubPRs",e)}async getPullRequest(t){const e={...t,integrationId:this.integrationId};return this.squid.executeFunction("getGitHubPR",e)}async listPullRequests(t={}){const e={...t,integrationId:this.integrationId};return this.squid.executeFunction("listGitHubPRs",e)}async searchCode(t){const e={...t,integrationId:this.integrationId};return this.squid.executeFunction("searchGitHubCode",e)}async getFileContent(t){const e={...t,integrationId:this.integrationId};return this.squid.executeFunction("getGitHubFile",e)}async createPullRequest(t){const e={...t,integrationId:this.integrationId};return this.squid.executeFunction("createGitHubPR",e)}async addPRComment(t){const e={...t,integrationId:this.integrationId};return this.squid.executeFunction("addGitHubPRComment",e)}async addPRReview(t){const e={...t,integrationId:this.integrationId};return this.squid.executeFunction("addGitHubPRReview",e)}async closePullRequest(t){const e={...t,integrationId:this.integrationId};return this.squid.executeFunction("closeGitHubPR",e)}async mergePullRequest(t){const e={...t,integrationId:this.integrationId};return this.squid.executeFunction("mergeGitHubPR",e)}async extractWebhookData(t){const e={...t,integrationId:this.integrationId};return this.squid.executeFunction("extractGitHubWebhookData",e)}}var n=exports;for(var s in e)n[s]=e[s];e.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();

package/dist/internal-common/src/public-types/communication.public-types.d.ts

@@ -0,0 +1,30 @@
+/** A type alias for an application id. */
+export type AppId = string;
+/** A tuple of environment identifiers like 'dev' or 'prod'. */
+export declare const ENVIRONMENT_IDS: readonly ["dev", "prod"];
+/** A type representing valid environment identifiers derived from ENVIRONMENT_IDS. */
+export type EnvironmentId = (typeof ENVIRONMENT_IDS)[number];
+/** A type alias for a squid developer identifier. */
+export type SquidDeveloperId = string;
+/** A type alias for an integration id. */
+export type IntegrationId = string;
+/** A type alias for a client identifier. */
+export type ClientId = string;
+/** A type alias for a squid document identifier. */
+export type SquidDocId = string;
+/** A type alias for a client request identifier. */
+export type ClientRequestId = string;
+/** ID of AI agent. Also known as AI profile id. */
+export type AiAgentId = string;
+/** App-level ID of AI Knowledge Base */
+export type AiKnowledgeBaseId = string;
+/**
+ * The built-in agent id. Cannot be customized.
+ * @category AI
+ */
+export declare const BUILT_IN_AGENT_ID = "built_in_agent";
+/**
+ * A type alias for an AI context identifier.
+ * @category AI
+ */
+export type AiContextId = string;

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@squidcloud/github-client",
+  "version": "1.0.426",
+  "description": "Squid GitHub Client",
+  "main": "dist/index.js",
+  "types": "dist/client/src/index.d.ts",
+  "scripts": {
+    "prebuild": "del-cli dist",
+    "build": "webpack --mode=production",
+    "lint": "eslint",
+    "publish:public": "npm run build && npm publish --access public"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "assertic": "^1.3.0",
+    "lodash": "^4.17.21",
+    "@squidcloud/client": "^1.0.426"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  }
+}