@squidcloud/jira-client 1.0.429

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

@@ -0,0 +1,184 @@
+import { IntegrationId } from '../../../../internal-common/src/public-types/communication.public-types';
+/**
+ * Jira API Types - Shared between backend and client
+ */
+export type JiraPriority = 1 | 2 | 3 | 4 | 5;
+export declare const PRIORITY_LABELS: Record<JiraPriority, string>;
+export interface JiraProject {
+    id: string;
+    key: string;
+    name: string;
+    description?: string;
+    projectTypeKey?: string;
+    avatarUrls?: Record<string, string>;
+}
+export interface JiraUser {
+    accountId: string;
+    displayName: string;
+    emailAddress?: string;
+    avatarUrls?: Record<string, string>;
+    active: boolean;
+}
+export interface JiraIssueType {
+    id: string;
+    name: string;
+    description?: string;
+    subtask: boolean;
+    iconUrl?: string;
+}
+export interface JiraStatus {
+    id: string;
+    name: string;
+    description?: string;
+    statusCategory: {
+        id: number;
+        key: string;
+        name: string;
+        colorName: string;
+    };
+}
+export interface JiraComment {
+    id: string;
+    body: string;
+    author: JiraUser;
+    created: string;
+    updated: string;
+}
+export interface JiraIssue {
+    id: string;
+    key: string;
+    summary: string;
+    description?: string;
+    priority?: {
+        id: string;
+        name: string;
+    };
+    status: JiraStatus;
+    issuetype: JiraIssueType;
+    project: JiraProject;
+    assignee?: JiraUser;
+    reporter?: JiraUser;
+    created: string;
+    updated: string;
+    labels?: Array<string>;
+}
+export interface JiraTransition {
+    id: string;
+    name: string;
+    to: JiraStatus;
+}
+export type RelatedIssuesMode = 'RESOLVED' | 'ALL' | 'NONE';
+export declare const RELATED_ISSUES_MODE_ENUM: Array<string>;
+/** Request to search Jira issues by text */
+export interface SearchJiraIssuesRequest {
+    /** The ID of the Jira integration */
+    integrationId: IntegrationId;
+    /** The search query to find issues */
+    query: string;
+    /** Optional project keys to filter by (comma-separated) */
+    projectKeys?: string;
+    /** Maximum number of issues to return (default: 50) */
+    limit?: number;
+}
+/** Request to search Jira issues by JQL */
+export interface SearchJiraIssuesByJqlRequest {
+    /** The ID of the Jira integration */
+    integrationId: IntegrationId;
+    /** The JQL query to execute */
+    jql: string;
+    /** Maximum number of issues to return (default: 50) */
+    limit?: number;
+}
+/** Request to get details of a Jira issue */
+export interface GetJiraIssueRequest {
+    /** The ID of the Jira integration */
+    integrationId: IntegrationId;
+    /** The Jira issue key (e.g., "PROJ-123") */
+    issueKey: string;
+    /** Whether to include related issues in the response */
+    relatedIssuesMode?: RelatedIssuesMode;
+}
+/** Request to create a Jira issue */
+export interface CreateJiraIssueRequest {
+    /** The ID of the Jira integration */
+    integrationId: IntegrationId;
+    /** The project key to create the issue in */
+    projectKey: string;
+    /** The title/summary of the issue */
+    summary: string;
+    /** The description of the issue */
+    description?: string;
+    /** The issue type (e.g., "Bug", "Task", "Story") */
+    issueType: string;
+    /** Priority name (e.g., "High", "Medium", "Low") */
+    priority?: string;
+    /** Email or account ID of the assignee */
+    assignee?: string;
+    /** Labels to apply to the issue */
+    labels?: Array<string>;
+}
+/** Request to update a Jira issue */
+export interface UpdateJiraIssueRequest {
+    /** The ID of the Jira integration */
+    integrationId: IntegrationId;
+    /** The Jira issue key (e.g., "PROJ-123") */
+    issueKey: string;
+    /** New summary for the issue */
+    summary?: string;
+    /** New description for the issue */
+    description?: string;
+    /** New priority name */
+    priority?: string;
+    /** Email or account ID of the new assignee */
+    assignee?: string;
+    /** Labels to set on the issue */
+    labels?: Array<string>;
+}
+/** Request to add a comment to a Jira issue */
+export interface AddJiraCommentRequest {
+    /** The ID of the Jira integration */
+    integrationId: IntegrationId;
+    /** The Jira issue key (e.g., "PROJ-123") */
+    issueKey: string;
+    /** The comment body */
+    body: string;
+}
+/** Request to transition a Jira issue */
+export interface TransitionJiraIssueRequest {
+    /** The ID of the Jira integration */
+    integrationId: IntegrationId;
+    /** The Jira issue key (e.g., "PROJ-123") */
+    issueKey: string;
+    /** The name of the transition to apply */
+    transitionName: string;
+}
+/** Request to list Jira projects */
+export interface ListJiraProjectsRequest {
+    /** The ID of the Jira integration */
+    integrationId: IntegrationId;
+}
+/** Response from Jira issue operations */
+export interface JiraIssueResponse {
+    /** Issue key (e.g., "PROJ-123") */
+    key: string;
+    /** Issue summary */
+    summary: string;
+    /** Issue URL */
+    url: string;
+}
+/** Response from listing projects */
+export interface JiraProjectResponse {
+    /** Project key (e.g., "PROJ") */
+    key: string;
+    /** Project name */
+    name: string;
+    /** Project description */
+    description?: string;
+}
+/** Response with issue details as XML string */
+export interface JiraIssueDetailsResponse {
+    /** Issue key */
+    key: string;
+    /** Issue details as formatted string */
+    details: string;
+}

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

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

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

@@ -0,0 +1,82 @@
+import { Squid } from '@squidcloud/client';
+import { CreateJiraIssueRequest, JiraIssueResponse, JiraProjectResponse, RelatedIssuesMode, SearchJiraIssuesByJqlRequest, SearchJiraIssuesRequest, UpdateJiraIssueRequest } from '../../common/src/jira-types';
+/**
+ * Client for interacting with the Jira connector.
+ *
+ * Provides methods to search, create, update issues, add comments,
+ * transition issues, and list projects from Jira.
+ */
+export declare class SquidJiraClient {
+    private readonly squid;
+    private readonly integrationId;
+    /**
+     * Creates a new Jira client instance.
+     *
+     * @param squid - Squid client instance. Provide an instance that includes the Squid API key.
+     * @param integrationId - The ID of the Jira integration in the Squid console.
+     */
+    constructor(squid: Squid, integrationId: string);
+    /**
+     * Search for Jira issues by text query.
+     *
+     * Returns issues matching the search term in summary, description, or comments.
+     *
+     * @param request - Search parameters.
+     * @returns Formatted string with matching issues.
+     */
+    searchIssues(request: Omit<SearchJiraIssuesRequest, 'integrationId'>): Promise<string>;
+    /**
+     * Search for Jira issues using JQL (Jira Query Language).
+     *
+     * Provides powerful filtering capabilities.
+     *
+     * @param request - Search parameters including JQL query.
+     * @returns Formatted string with matching issues.
+     */
+    searchByJql(request: Omit<SearchJiraIssuesByJqlRequest, 'integrationId'>): Promise<string>;
+    /**
+     * Get detailed information about a specific Jira issue.
+     *
+     * @param issueKey - The Jira issue key (e.g., "PROJ-123").
+     * @param relatedIssuesMode - Whether to include related issues (default: 'RESOLVED').
+     * @returns Formatted string with issue details including comments.
+     */
+    getIssue(issueKey: string, relatedIssuesMode?: RelatedIssuesMode): Promise<string>;
+    /**
+     * Create a new Jira issue.
+     *
+     * @param request - Create parameters including project, summary, and issue type.
+     * @returns The created issue information.
+     */
+    createIssue(request: Omit<CreateJiraIssueRequest, 'integrationId'>): Promise<JiraIssueResponse>;
+    /**
+     * Update an existing Jira issue.
+     *
+     * @param request - Update parameters including issue key and fields to update.
+     * @returns The updated issue information.
+     */
+    updateIssue(request: Omit<UpdateJiraIssueRequest, 'integrationId'>): Promise<JiraIssueResponse>;
+    /**
+     * Add a comment to a Jira issue.
+     *
+     * @param issueKey - The Jira issue key (e.g., "PROJ-123").
+     * @param body - The comment text.
+     * @returns The created comment ID.
+     */
+    addComment(issueKey: string, body: string): Promise<{
+        commentId: string;
+    }>;
+    /**
+     * Transition a Jira issue to a different status.
+     *
+     * @param issueKey - The Jira issue key (e.g., "PROJ-123").
+     * @param transitionName - The name of the transition (e.g., "Done", "In Progress").
+     */
+    transitionIssue(issueKey: string, transitionName: string): Promise<void>;
+    /**
+     * List available Jira projects.
+     *
+     * @returns Array of projects with their key, name, and description.
+     */
+    listProjects(): Promise<Array<JiraProjectResponse>>;
+}

package/dist/index.js

@@ -0,0 +1 @@
+(()=>{"use strict";var e={d:(t,i)=>{for(var s in i)e.o(i,s)&&!e.o(t,s)&&Object.defineProperty(t,s,{enumerable:!0,get:i[s]})},o:(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},t={};e.r(t),e.d(t,{PRIORITY_LABELS:()=>i,RELATED_ISSUES_MODE_ENUM:()=>s,SquidJiraClient:()=>n});const i={1:"Highest",2:"High",3:"Medium",4:"Low",5:"Lowest"},s=["RESOLVED","ALL","NONE"];class n{constructor(e,t){this.squid=e,this.integrationId=t}async searchIssues(e){const t={...e,integrationId:this.integrationId};return this.squid.executeFunction("searchJiraIssuesExecutable",t)}async searchByJql(e){const t={...e,integrationId:this.integrationId};return this.squid.executeFunction("searchJiraIssuesByJqlExecutable",t)}async getIssue(e,t){const i={integrationId:this.integrationId,issueKey:e,relatedIssuesMode:t};return this.squid.executeFunction("getJiraIssueDetailsExecutable",i)}async createIssue(e){const t={...e,integrationId:this.integrationId};return this.squid.executeFunction("createJiraIssueExecutable",t)}async updateIssue(e){const t={...e,integrationId:this.integrationId};return this.squid.executeFunction("updateJiraIssueExecutable",t)}async addComment(e,t){const i={integrationId:this.integrationId,issueKey:e,body:t};return this.squid.executeFunction("addJiraCommentExecutable",i)}async transitionIssue(e,t){const i={integrationId:this.integrationId,issueKey:e,transitionName:t};return this.squid.executeFunction("transitionJiraIssueExecutable",i)}async listProjects(){const e={integrationId:this.integrationId};return this.squid.executeFunction("listJiraProjectsExecutable",e)}}var r=exports;for(var a in t)r[a]=t[a];t.__esModule&&Object.defineProperty(r,"__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,31 @@
+{
+  "name": "@squidcloud/jira-client",
+  "version": "1.0.429",
+  "description": "Squid Jira Client - SDK for interacting with the Jira connector",
+  "main": "dist/index.js",
+  "types": "dist/jira-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": [
+    "squid",
+    "jira",
+    "issue-tracking",
+    "connector"
+  ],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "assertic": "^1.3.0",
+    "@squidcloud/client": "^1.0.429"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  }
+}