@squidcloud/jira-jsm-client 1.0.433

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

@@ -0,0 +1,224 @@
+import { IntegrationId } from '../../../../internal-common/src/public-types/communication.public-types';
+/**
+ * Jira Service Management API Types - Shared between backend and client
+ */
+export type JsmPriority = 1 | 2 | 3 | 4 | 5;
+export declare const PRIORITY_LABELS: Record<JsmPriority, string>;
+export interface JsmServiceDesk {
+    id: string;
+    projectId: string;
+    projectKey: string;
+    projectName: string;
+}
+export interface JsmUser {
+    accountId: string;
+    displayName: string;
+    emailAddress?: string;
+    avatarUrls?: Record<string, string>;
+    active: boolean;
+}
+export interface JsmCustomer {
+    accountId: string;
+    displayName: string;
+    emailAddress?: string;
+    active?: boolean;
+}
+export interface JsmOrganization {
+    id: string;
+    name: string;
+}
+export interface JsmRequestType {
+    id: string;
+    name: string;
+    description?: string;
+    serviceDeskId: string;
+    groupIds?: Array<string>;
+    portalId?: string;
+}
+export interface JsmStatus {
+    id: string;
+    name: string;
+    description?: string;
+    statusCategory: {
+        id: number;
+        key: string;
+        name: string;
+        colorName: string;
+    };
+}
+export interface JsmComment {
+    id: string;
+    body: string;
+    author: JsmUser;
+    created: string;
+    public: boolean;
+}
+export interface JsmSla {
+    id: string;
+    name: string;
+    completedCycles?: Array<{
+        startTime: string;
+        stopTime: string;
+        breached: boolean;
+        goalDuration: {
+            millis: number;
+            friendly: string;
+        };
+        elapsedTime: {
+            millis: number;
+            friendly: string;
+        };
+        remainingTime: {
+            millis: number;
+            friendly: string;
+        };
+    }>;
+    ongoingCycle?: {
+        startTime: string;
+        breached: boolean;
+        paused: boolean;
+        withinCalendarHours: boolean;
+        goalDuration: {
+            millis: number;
+            friendly: string;
+        };
+        elapsedTime: {
+            millis: number;
+            friendly: string;
+        };
+        remainingTime: {
+            millis: number;
+            friendly: string;
+        };
+    };
+}
+export interface JsmRequest {
+    issueId: string;
+    issueKey: string;
+    requestTypeId: string;
+    serviceDeskId: string;
+    createdDate: string;
+    reporter: JsmCustomer;
+    requestFieldValues?: Array<{
+        fieldId: string;
+        label: string;
+        value: unknown;
+    }>;
+    currentStatus: JsmStatus;
+    _links?: Record<string, string>;
+}
+export interface JsmRequestFull extends JsmRequest {
+    summary?: string;
+    description?: string;
+    priority?: {
+        id: string;
+        name: string;
+    };
+    assignee?: JsmUser;
+    participants?: Array<JsmCustomer>;
+    organizations?: Array<JsmOrganization>;
+    slas?: Array<JsmSla>;
+    requestType?: JsmRequestType;
+    url: string;
+}
+export interface JsmRequestDetails {
+    request: JsmRequestFull;
+    comments: Array<JsmComment>;
+    detailsAsString: string;
+}
+/** Request to list service desks */
+export interface ListJsmServiceDesksRequest {
+    integrationId: IntegrationId;
+}
+/** Request to list request types for a service desk */
+export interface ListJsmRequestTypesRequest {
+    integrationId: IntegrationId;
+    serviceDeskId: string;
+}
+/** Request to search JSM requests by text */
+export interface SearchJsmRequestsRequest {
+    integrationId: IntegrationId;
+    query: string;
+    serviceDeskId?: string;
+    requestStatus?: 'OPEN' | 'CLOSED' | 'ALL';
+    limit?: number;
+}
+/** Request to get details of a JSM request */
+export interface GetJsmRequestRequest {
+    integrationId: IntegrationId;
+    issueIdOrKey: string;
+    relatedRequestsMode?: RelatedRequestsMode;
+}
+/** Request to create a JSM request */
+export interface CreateJsmRequestRequest {
+    integrationId: IntegrationId;
+    serviceDeskId: string;
+    requestTypeId: string;
+    summary: string;
+    description?: string;
+    priority?: string;
+    reporterEmail?: string;
+    requestFieldValues?: Record<string, unknown>;
+}
+/** Request to update a JSM request */
+export interface UpdateJsmRequestRequest {
+    integrationId: IntegrationId;
+    issueIdOrKey: string;
+    summary?: string;
+    description?: string;
+    priority?: string;
+    assignee?: string;
+}
+/** Request to add a comment to a JSM request */
+export interface AddJsmCommentRequest {
+    integrationId: IntegrationId;
+    issueIdOrKey: string;
+    body: string;
+    public?: boolean;
+}
+/** Request to transition a JSM request */
+export interface TransitionJsmRequestRequest {
+    integrationId: IntegrationId;
+    issueIdOrKey: string;
+    transitionId: string;
+}
+/** Request to list customers */
+export interface ListJsmCustomersRequest {
+    integrationId: IntegrationId;
+    serviceDeskId: string;
+    query?: string;
+    limit?: number;
+}
+/** Request to add a customer to a service desk */
+export interface AddJsmCustomerRequest {
+    integrationId: IntegrationId;
+    serviceDeskId: string;
+    email: string;
+    displayName?: string;
+}
+export type RelatedRequestsMode = 'RESOLVED' | 'ALL' | 'NONE';
+export declare const RELATED_REQUESTS_MODE_ENUM: Array<string>;
+/** Response from JSM request operations */
+export interface JsmRequestResponse {
+    issueKey: string;
+    summary?: string;
+    url: string;
+}
+/** Response from listing service desks */
+export interface JsmServiceDeskResponse {
+    id: string;
+    projectKey: string;
+    projectName: string;
+}
+/** Response from listing request types */
+export interface JsmRequestTypeResponse {
+    id: string;
+    name: string;
+    description?: string;
+}
+/** Response from listing customers */
+export interface JsmCustomerResponse {
+    accountId: string;
+    displayName: string;
+    emailAddress?: string;
+}

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

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

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

@@ -0,0 +1,88 @@
+import { Squid } from '@squidcloud/client';
+import { CreateJsmRequestRequest, JsmCustomerResponse, JsmRequestDetails, JsmRequestResponse, JsmRequestTypeResponse, JsmServiceDeskResponse, RelatedRequestsMode, SearchJsmRequestsRequest, UpdateJsmRequestRequest } from '../../common/src/jira-jsm-types';
+/**
+ * Client for interacting with the Jira Service Management connector.
+ *
+ * Provides methods to manage support tickets, service desks, request types,
+ * and customers in Jira Service Management.
+ */
+export declare class SquidJiraJsmClient {
+    private readonly squid;
+    private readonly integrationId;
+    /**
+     * Creates a new JSM client instance.
+     *
+     * @param squid - Squid client instance. Provide an instance that includes the Squid API key.
+     * @param integrationId - The ID of the JSM integration in the Squid console.
+     */
+    constructor(squid: Squid, integrationId: string);
+    /**
+     * List available service desks.
+     *
+     * @returns Array of service desks with their ID, project key, and name.
+     */
+    listServiceDesks(): Promise<Array<JsmServiceDeskResponse>>;
+    /**
+     * List request types available in a service desk.
+     *
+     * @param serviceDeskId - The service desk ID.
+     * @returns Array of request types with their ID, name, and description.
+     */
+    listRequestTypes(serviceDeskId: string): Promise<Array<JsmRequestTypeResponse>>;
+    /**
+     * Search for JSM requests by text query.
+     *
+     * @param request - Search parameters.
+     * @returns Formatted string with matching requests.
+     */
+    searchRequests(request: Omit<SearchJsmRequestsRequest, 'integrationId'>): Promise<string>;
+    /**
+     * Get detailed information about a specific JSM request.
+     *
+     * @param issueIdOrKey - The JSM request key or ID (e.g., "HELP-123").
+     * @param relatedRequestsMode - Whether to include related requests (default: 'RESOLVED').
+     * @returns Request details including request object, comments, and formatted details string.
+     */
+    getRequest(issueIdOrKey: string, relatedRequestsMode?: RelatedRequestsMode): Promise<JsmRequestDetails>;
+    /**
+     * Create a new JSM request (support ticket).
+     *
+     * @param request - Create parameters including service desk, request type, and summary.
+     * @returns The created request information.
+     */
+    createRequest(request: Omit<CreateJsmRequestRequest, 'integrationId'>): Promise<JsmRequestResponse>;
+    /**
+     * Update an existing JSM request.
+     *
+     * @param request - Update parameters including issue key and fields to update.
+     * @returns The updated request information.
+     */
+    updateRequest(request: Omit<UpdateJsmRequestRequest, 'integrationId'>): Promise<JsmRequestResponse>;
+    /**
+     * Add a comment to a JSM request.
+     *
+     * @param issueIdOrKey - The JSM request key (e.g., "HELP-123").
+     * @param body - The comment text.
+     * @param isPublic - Whether the comment is public (visible to customer) or internal. Default: true.
+     * @returns The created comment ID.
+     */
+    addComment(issueIdOrKey: string, body: string, isPublic?: boolean): Promise<{
+        commentId: string;
+    }>;
+    /**
+     * Transition a JSM request to a different status.
+     *
+     * @param issueIdOrKey - The JSM request key (e.g., "HELP-123").
+     * @param transitionId - The ID of the transition to apply.
+     */
+    transitionRequest(issueIdOrKey: string, transitionId: string): Promise<void>;
+    /**
+     * List customers in a service desk.
+     *
+     * @param serviceDeskId - The service desk ID.
+     * @param query - Optional search query to filter customers.
+     * @param limit - Maximum number of customers to return.
+     * @returns Array of customers with their account ID, display name, and email.
+     */
+    listCustomers(serviceDeskId: string, query?: string, limit?: number): Promise<Array<JsmCustomerResponse>>;
+}

package/dist/index.js

@@ -0,0 +1 @@
+(()=>{"use strict";var e={d:(t,s)=>{for(var i in s)e.o(s,i)&&!e.o(t,i)&&Object.defineProperty(t,i,{enumerable:!0,get:s[i]})},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:()=>s,RELATED_REQUESTS_MODE_ENUM:()=>i,SquidJiraJsmClient:()=>n});const s={1:"Highest",2:"High",3:"Medium",4:"Low",5:"Lowest"},i=["RESOLVED","ALL","NONE"];class n{constructor(e,t){this.squid=e,this.integrationId=t}async listServiceDesks(){const e={integrationId:this.integrationId};return this.squid.executeFunction("listJsmServiceDesksExecutable",e)}async listRequestTypes(e){const t={integrationId:this.integrationId,serviceDeskId:e};return this.squid.executeFunction("listJsmRequestTypesExecutable",t)}async searchRequests(e){const t={...e,integrationId:this.integrationId};return this.squid.executeFunction("searchJsmRequestsExecutable",t)}async getRequest(e,t){const s={integrationId:this.integrationId,issueIdOrKey:e,relatedRequestsMode:t};return this.squid.executeFunction("getJsmRequestDetailsExecutable",s)}async createRequest(e){const t={...e,integrationId:this.integrationId};return this.squid.executeFunction("createJsmRequestExecutable",t)}async updateRequest(e){const t={...e,integrationId:this.integrationId};return this.squid.executeFunction("updateJsmRequestExecutable",t)}async addComment(e,t,s=!0){const i={integrationId:this.integrationId,issueIdOrKey:e,body:t,public:s};return this.squid.executeFunction("addJsmCommentExecutable",i)}async transitionRequest(e,t){const s={integrationId:this.integrationId,issueIdOrKey:e,transitionId:t};return this.squid.executeFunction("transitionJsmRequestExecutable",s)}async listCustomers(e,t,s){const i={integrationId:this.integrationId,serviceDeskId:e,query:t,limit:s};return this.squid.executeFunction("listJsmCustomersExecutable",i)}}var r=exports;for(var u in t)r[u]=t[u];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,33 @@
+{
+  "name": "@squidcloud/jira-jsm-client",
+  "version": "1.0.433",
+  "description": "Squid Jira Service Management Client - SDK for interacting with the JSM connector",
+  "main": "dist/index.js",
+  "types": "dist/jira-jsm-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",
+    "jira-service-management",
+    "jsm",
+    "support-tickets",
+    "connector"
+  ],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "assertic": "^1.3.0",
+    "@squidcloud/client": "^1.0.433"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  }
+}