gaunt-sloth-assistant 0.7.2 → 0.7.3

package/src/helpers/jira/jiraLogWork.ts

@@ -0,0 +1,81 @@
+import type { JiraConfig } from '#src/providers/types.js';
+import { getJiraCredentials, jiraRequest } from './jiraClient.js';
+import { displayError, displaySuccess } from '#src/consoleUtils.js';
+
+interface WorklogRequestBody {
+  comment: {
+    content: Array<{
+      content: Array<{
+        text: string;
+        type: 'text';
+      }>;
+      type: 'paragraph';
+    }>;
+    type: 'doc';
+    version: 1;
+  };
+  started: string;
+  timeSpentSeconds: number;
+}
+
+export default async function jiraLogWork(
+  config: Partial<JiraConfig> | null,
+  jiraId: string,
+  timeInSeconds: number,
+  comment: string = 'Work logged',
+  startedAt: Date = new Date()
+): Promise<string> {
+  try {
+    // Use provided config or empty config (will use environment variables)
+    const credentials = getJiraCredentials(config);
+
+    const bodyData: WorklogRequestBody = {
+      comment: {
+        content: [
+          {
+            content: [
+              {
+                text: comment,
+                type: 'text',
+              },
+            ],
+            type: 'paragraph',
+          },
+        ],
+        type: 'doc',
+        version: 1,
+      },
+      started: startedAt.toISOString().replace('Z', '+0000'),
+      timeSpentSeconds: timeInSeconds,
+    };
+
+    /**
+     * https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs/#api-rest-api-3-issue-issueidorkey-worklog-post
+     * Needs:
+     * Classic RECOMMENDED:write:jira-work
+     *
+     * OR
+     *
+     * write:issue-worklog:jira, write:issue-worklog.property:jira, read:avatar:jira, read:group:jira,
+     * read:issue-worklog:jira, read:project-role:jira, read:user:jira, read:issue-worklog.property:jira
+     */
+    await jiraRequest(credentials, `/rest/api/3/issue/${jiraId}/worklog`, {
+      method: 'POST',
+      body: JSON.stringify(bodyData),
+    });
+
+    const hours = Math.floor(timeInSeconds / 3600);
+    const minutes = Math.floor((timeInSeconds % 3600) / 60);
+    const timeStr = hours > 0 ? `${hours}h ${minutes}m` : `${minutes}m`;
+
+    const successMessage = `✅ Logged ${timeStr} to ${jiraId}`;
+    displaySuccess(successMessage);
+    return successMessage;
+  } catch (error) {
+    const errorMessage = `Failed to log work to Jira: ${
+      error instanceof Error ? error.message : String(error)
+    }`;
+    displayError(errorMessage);
+    return errorMessage;
+  }
+}

package/src/providers/jiraIssueProvider.ts

@@ -1,7 +1,6 @@
 import { display, displayError, displayWarning } from '#src/consoleUtils.js';
-import { env } from '#src/systemUtils.js';
 import type { JiraConfig } from './types.js';
-import { ProgressIndicator } from '#src/utils.js';
+import { getJiraCredentials, jiraRequest } from '#src/helpers/jira/jiraClient.js';
 
 interface JiraIssueResponse {
   fields: {
@@ -35,40 +34,10 @@ export async function get(
     return null;
   }
 
-  // Get username from environment variable or config
-  const username = env.JIRA_USERNAME || config.username;
-  if (!username) {
-    throw new Error(
-      'Missing JIRA username. The username can be defined as JIRA_USERNAME environment variable or as "username" in config.'
-    );
-  }
-
-  // Get token from environment variable or config
-  const token = env.JIRA_API_PAT_TOKEN || config.token;
-  if (!token) {
-    throw new Error(
-      'Missing JIRA PAT token. The token can be defined as JIRA_API_PAT_TOKEN environment variable or as "token" in config.'
-    );
-  }
-
-  // Get cloud ID from environment variable or config
-  const cloudId = env.JIRA_CLOUD_ID || config.cloudId;
-  if (!cloudId) {
-    throw new Error(
-      'Missing JIRA Cloud ID. The Cloud ID can be defined as JIRA_CLOUD_ID environment variable or as "cloudId" in config.'
-    );
-  }
+  const credentials = getJiraCredentials(config);
 
   try {
-    const issue = await getJiraIssue(
-      {
-        ...config,
-        username,
-        token,
-        cloudId,
-      },
-      issueId
-    );
+    const issue = await getJiraIssue(credentials, issueId);
     if (!issue) {
       return null;
     }
@@ -95,52 +64,26 @@ export async function get(
  * @param jiraKey Jira issue ID
  * @returns Jira issue response
  */
-async function getJiraIssue(config: JiraConfig, jiraKey: string): Promise<JiraIssueResponse> {
+async function getJiraIssue(
+  credentials: { username: string; token: string; cloudId: string; displayUrl?: string },
+  jiraKey: string
+): Promise<JiraIssueResponse> {
   // Jira Cloud ID can be found by authenticated user at https://company.atlassian.net/_edge/tenant_info
 
   // According to doc https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-get permissions to read this resource:
   // https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-issueidorkey-get
   // either Classic (RECOMMENDED) read:jira-work
-  // or Granular read:issue-meta:jira, read:issue-security-level:jira, read:issue.vote:jira, read:issue.changelog:jira, read:avatar:jira, read:issue:jira, read:status:jira, read:user:jira, read:field-configuration:jira
-  const apiUrl = `https://api.atlassian.com/ex/jira/${config.cloudId}/rest/api/2/issue/${jiraKey}`;
-  if (config.displayUrl) {
-    display(`Loading Jira issue ${config.displayUrl}${jiraKey}`);
+  // or Granular read:issue-meta:jira, read:issue-security-level:jira, read:issue.vote:jira, read:issue.changelog:jira,
+  // read:avatar:jira, read:issue:jira, read:status:jira, read:user:jira, read:field-configuration:jira
+
+  if (credentials.displayUrl) {
+    display(`Loading Jira issue ${credentials.displayUrl}${jiraKey}`);
   }
 
   // This filter will be necessary for V3: `&expand=renderedFields` to convert ADF to HTML
   const filters = '?fields=summary,description'; // Limit JSON to summary and description
 
-  // Encode credentials for Basic Authentication header
-  const credentials = `${config.username}:${config.token}`;
-  const encodedCredentials = Buffer.from(credentials).toString('base64');
-  const authHeader = `Basic ${encodedCredentials}`;
-
-  // Define request headers
-  const headers = {
-    Authorization: authHeader,
-    Accept: 'application/json; charset=utf-8',
-    'Accept-Language': 'en-US,en;q=0.9', // Prevents errors in other languages
-  };
-
-  const progressIndicator = new ProgressIndicator(
-    `Retrieving jira from api ${apiUrl.replace(/^https?:\/\//, '')}`
-  );
-  const response = await fetch(apiUrl + filters, {
+  return jiraRequest<JiraIssueResponse>(credentials, `/rest/api/2/issue/${jiraKey}${filters}`, {
     method: 'GET',
-    headers: headers,
   });
-  progressIndicator.stop();
-
-  if (!response?.ok) {
-    try {
-      const errorData = await response.json();
-      throw new Error(
-        `Failed to fetch Jira issue: ${response.statusText} - ${JSON.stringify(errorData)}`
-      );
-    } catch (_e) {
-      throw new Error(`Failed to fetch Jira issue: ${response?.statusText}`);
-    }
-  }
-
-  return response.json();
 }

package/src/tools/gthJiraLogWorkTool.ts

@@ -0,0 +1,51 @@
+import { type StructuredToolInterface, tool } from '@langchain/core/tools';
+import { z } from 'zod';
+import { displayWarning } from '#src/consoleUtils.js';
+import jiraLogWork from '#src/helpers/jira/jiraLogWork.js';
+import type { JiraConfig } from '#src/providers/types.js';
+import { SlothConfig } from '#src/config.js';
+
+// Define the input schema for the tool
+const gthJiraLogWorkSchema = z.object({
+  jiraId: z.string().describe('The Jira issue ID (e.g., "PROJ-123")'),
+  timeInSeconds: z.number().describe('Time spent in seconds'),
+  comment: z.string().optional().describe('Work log comment'),
+  startedAt: z.string().optional().describe('ISO 8601 date string for when work started'),
+});
+
+const toolDefinition = {
+  name: 'gth_jira_log_work',
+  description: `Gaunt Sloth Jira Log Work Tool. Log work time to a Jira issue. Requires Jira configuration with credentials.
+Example: gth_jira_log_work({ jiraId: "PROJ-123", timeInSeconds: 3600, comment: "Implemented feature X" })`,
+  schema: gthJiraLogWorkSchema,
+};
+
+function getToolImpl(config?: Partial<JiraConfig>): StructuredToolInterface {
+  let toolImpl = async ({
+    jiraId,
+    timeInSeconds,
+    comment = 'Work logged',
+    startedAt,
+  }: z.infer<typeof gthJiraLogWorkSchema>): Promise<string> => {
+    const jiraConfig = config || {};
+
+    const startDate = startedAt ? new Date(startedAt) : new Date();
+
+    return await jiraLogWork(jiraConfig, jiraId, timeInSeconds, comment, startDate);
+  };
+  return tool(toolImpl, toolDefinition);
+}
+
+// Export a default instance that uses environment variables
+export function get(config: SlothConfig) {
+  if (!config.prebuiltToolsConfig?.jira && config.requirementsProviderConfig?.jira) {
+    displayWarning(
+      'config.prebuiltToolsConfig.jira is not defined. Using config.requirementsProviderConfig.jira.'
+    );
+  }
+  let jiraConfig = config.prebuiltToolsConfig?.jira || config.requirementsProviderConfig?.jira;
+  if (!jiraConfig) {
+    throw new Error('gth_jira_log_work is added to preBuiltTools, but no Jira config is provided.');
+  }
+  return getToolImpl(jiraConfig);
+}

package/src/tools/gthStatusUpdateTool.ts

@@ -0,0 +1,18 @@
+import { tool } from '@langchain/core/tools';
+import { z } from 'zod';
+import chalk from 'chalk';
+import { display } from '#src/consoleUtils.js';
+import { SlothConfig } from '#src/config.js';
+
+const toolDefinition = {
+  name: 'gth_status_update',
+  description: `Gaunt Sloth Status Update Tool. Use this tool to update status in the console. Example: gth_status_update "Working on something important", be brief, feel free to use emojis. Update after using tools.`,
+  schema: z.string(),
+};
+const toolImpl = (s: string): void => {
+  display(chalk.grey(s));
+};
+
+export function get(_: SlothConfig) {
+  return tool(toolImpl, toolDefinition);
+}

package/vitest-it.config.ts

@@ -5,7 +5,7 @@ export default defineConfig({
     include: ['integration-tests/**/*.it.ts'],
     environment: 'node',
     globals: true,
-    testTimeout: 1000 * 60 * 3,
+    testTimeout: 1000 * 60 * 5,
     maxWorkers: 1,
     fileParallelism: false,
   },

package/vitest.config.ts

@@ -9,5 +9,6 @@ export default defineConfig({
       reporter: ['text', 'json', 'html'],
     },
     globals: true,
+    testTimeout: 10000,
   },
 });

package/dist/tools/statusUpdate.d.ts

@@ -1 +0,0 @@
-export declare const statusUpdate: import("@langchain/core/tools").DynamicTool<void>;

package/dist/tools/statusUpdate.js

@@ -1,12 +0,0 @@
-import { tool } from '@langchain/core/tools';
-import { z } from 'zod';
-import chalk from 'chalk';
-import { display } from '#src/consoleUtils.js';
-export const statusUpdate = tool((s) => {
-    display(chalk.grey(s));
-}, {
-    name: 'status_update',
-    description: `Status Update Tool. Use this tool to update status in the console. Example: status_update "Working on something important", be brief, feel free to use emojis. Update after using tools.`,
-    schema: z.string(),
-});
-//# sourceMappingURL=statusUpdate.js.map

package/dist/tools/statusUpdate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"statusUpdate.js","sourceRoot":"","sources":["../../src/tools/statusUpdate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAC9B,CAAC,CAAS,EAAQ,EAAE;IAClB,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACzB,CAAC,EACD;IACE,IAAI,EAAE,eAAe;IACrB,WAAW,EAAE,0LAA0L;IACvM,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;CACnB,CACF,CAAC"}

package/src/tools/statusUpdate.ts

@@ -1,15 +0,0 @@
-import { tool } from '@langchain/core/tools';
-import { z } from 'zod';
-import chalk from 'chalk';
-import { display } from '#src/consoleUtils.js';
-
-export const statusUpdate = tool(
-  (s: string): void => {
-    display(chalk.grey(s));
-  },
-  {
-    name: 'status_update',
-    description: `Status Update Tool. Use this tool to update status in the console. Example: status_update "Working on something important", be brief, feel free to use emojis. Update after using tools.`,
-    schema: z.string(),
-  }
-);