Merge pull request #179 from forcedotcom/phale/llmservice-release

W-17969813: feat: add a4d llm service as an api

Author: peternhale

.husky/pre-commit

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-yarn lint-staged
+yarn test

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/vscode-service-provider",
-  "version": "1.2.2",
+  "version": "1.3.0-rc.6.6",
   "description": "Library that provides access to Salesforce VSCode Service Provider",
   "main": "lib/src/index.js",
   "author": "Peter Hale <peter.hale@salesforce.com>",
@@ -52,7 +52,7 @@
     "package": "yarn pack",
     "prettier": "prettier ./**/*.{js,json,ts,md} --write",
     "format:check": "prettier ./**/*.{js,json,ts,md} --debug-check",
-    "prepare": "husky install"
+    "prepare": "husky"
   },
   "config": {
     "commitizen": {

src/index.ts

@@ -10,3 +10,5 @@ export * from './types';
 
 export const telemetryCommand = 'sf.vscode.core.get.telemetry';
 export const loggerCommand = 'sf.vscode.core.logger.get.instance';
+export const llmServiceCommand =
+  'salesforcedx-einstein-gpt.getLLMServiceInstance';

src/services/serviceProvider.ts

@@ -12,7 +12,7 @@ import {
   ServiceValidators
 } from '../types';
 import * as vscode from 'vscode';
-import { loggerCommand, telemetryCommand } from '../index';
+import { llmServiceCommand, loggerCommand, telemetryCommand } from '../index';
 
 /**
  * The ServiceProvider class is a utility class that provides services of different types.
@@ -25,6 +25,19 @@ export class ServiceProvider {
     Map<string, ServiceReturnType<ServiceType>>
   > = new Map();
 
+  /**
+   * Checks if the service is available to be created and returned from the {@link getService} method.
+   * Specifically, this method checks if there even is a command associated with the specified
+   * @{link ServiceType} registered within VS Code.
+   * @param type - The type of the service.
+   * @returns The value true if the service is available and false otherwise.
+   */
+  static async isServiceAvailable<T extends ServiceType>(
+    type: T
+  ): Promise<boolean> {
+    return (await this.getCommands()).includes(this.getCommandString(type));
+  }
+
   /**
    * Retrieves a service instance of the specified type and instance name.
    * If the service instance does not exist, it will be created.
@@ -99,7 +112,7 @@ export class ServiceProvider {
   }
 
   /**
-   * Checks if a service of the specified type exists.
+   * Checks if a service of the specified type exists yet within the cache of the ServiceProvider.
    * @param type - The type of the service.
    * @returns True if the service exists, false otherwise.
    */
@@ -108,7 +121,7 @@ export class ServiceProvider {
   }
 
   /**
-   * Checks if a service instance of the specified type and instance name exists.
+   * Checks if a service instance of the specified type and instance name exists yet within the cache of the ServiceProvider.
    * @param type - The type of the service.
    * @param instanceName - The name of the service instance.
    * @returns True if the service instance exists, false otherwise.
@@ -195,6 +208,8 @@ export class ServiceProvider {
         return loggerCommand;
       case ServiceType.Telemetry:
         return telemetryCommand;
+      case ServiceType.LLMService:
+        return llmServiceCommand;
       default:
         throw new Error(`Unsupported service type: ${type}`);
     }

src/types/index.ts

@@ -7,18 +7,28 @@
 
 import { LoggerInterface } from './logger/loggerTypes';
 import { TelemetryServiceInterface } from './telemetry/telemetryTypes';
+import { LLMServiceInterface } from './llmService';
 
 export const SFDX_CORE_EXTENSION_NAME = 'salesforcedx-vscode-core';
 
 export enum ServiceType {
   Logger = 'Logger',
-  Telemetry = 'Telemetry'
+  Telemetry = 'Telemetry',
+  LLMService = 'LLMService'
 }
 
 // Define a mapping from service types to their corresponding parameter types
 interface ServiceParamsMap {
   [ServiceType.Logger]: [string]; // Logger requires a string parameter
   [ServiceType.Telemetry]: [string | undefined];
+  [ServiceType.LLMService]: [string];
+}
+
+// Define a mapping from service types to their corresponding return types
+interface ServiceReturnTypeMap {
+  [ServiceType.Telemetry]: TelemetryServiceInterface;
+  [ServiceType.Logger]: LoggerInterface;
+  [ServiceType.LLMService]: LLMServiceInterface;
 }
 
 // Define a type that represents the parameter types for a given service type
@@ -27,11 +37,7 @@ export type ServiceParams<T extends ServiceType> =
 
 // Define a type that represents the return type for a given service type
 export type ServiceReturnType<T extends ServiceType> =
-  T extends ServiceType.Telemetry
-    ? TelemetryServiceInterface
-    : T extends ServiceType.Logger
-      ? LoggerInterface
-      : never;
+  T extends keyof ServiceReturnTypeMap ? ServiceReturnTypeMap[T] : never;
 
 // Define a ServiceValidator interface
 interface ServiceValidator<T extends ServiceType> {
@@ -55,8 +61,14 @@ export const ServiceValidators: {
     ): ServiceParams<ServiceType.Telemetry> {
       return params;
     }
+  },
+  [ServiceType.LLMService]: {
+    validateAndCorrect(
+      params: ServiceParams<ServiceType.LLMService>
+    ): ServiceParams<ServiceType.LLMService> {
+      return params;
+    }
   }
-  // Add more validators as needed
 };
 
 // Define a ServiceInstanceValidator interface
@@ -78,8 +90,16 @@ export const ServiceInstanceValidators: {
     validateAndCorrect(instanceName: string): string {
       return instanceName || SFDX_CORE_EXTENSION_NAME;
     }
+  },
+  [ServiceType.LLMService]: {
+    validateAndCorrect(extensionName: string): string {
+      if (!extensionName) {
+        throw new Error('Extension name is required for LLM service');
+      }
+      return extensionName;
+    }
   }
-  // Add more validators as needed
 };
 export * from './logger/loggerTypes';
 export * from './telemetry/telemetryTypes';
+export * from './llmService';

src/types/llmService/LLMService.ts

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+/**
+ * Interface representing a service for calling a Large Language Model (LLM).
+ */
+export interface LLMServiceInterface {
+  /**
+   * Calls the LLM with the provided engineered prompt, prompt ID, and input token limit.
+   * @param engineeredPrompt - The prompt that has been engineered for the LLM.
+   * @param promptId - The ID of the prompt (optional).
+   * @param outputTokenLimit - The limit on the number of output tokens (optional).
+   * @param options - The object of other options in the request (optional)
+   * @returns A promise that resolves to the LLM's response as a string.
+   */
+  callLLM(
+    engineeredPrompt: string,
+    promptId?: string,
+    outputTokenLimit?: number,
+    options?: CallLLMOptions
+  ): Promise<string>;
+}
+
+export type CallLLMOptions = {
+  // Values to be added to the parameters property on the request.
+  parameters?: {
+    guided_json?: string; // TODO: define the type in detail
+  };
+  // Properties to be added to the body of the request.
+  properties?: {
+    stop_sequence?: string[]; // TODO: define the type in detail
+  };
+};

src/types/llmService/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+export * from './LLMService';

test/services/serviceProvider.test.ts

@@ -110,6 +110,26 @@ describe('ServiceProvider', () => {
     });
   });
 
+  it('should correctly identify that a service is available if the associated command is registered', async () => {
+    const isAvailable = await ServiceProvider.isServiceAvailable(
+      ServiceType.Telemetry
+    );
+    expect(isAvailable).toBe(true);
+  });
+
+  it('should correctly identify that a service is not available if the associated command is not registered', async () => {
+    jest
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      .spyOn(ServiceProvider as any, 'getCommands')
+      .mockImplementation(() => {
+        return Promise.resolve([loggerCommand]);
+      });
+    const isAvailable = await ServiceProvider.isServiceAvailable(
+      ServiceType.Telemetry
+    );
+    expect(isAvailable).toBe(false);
+  });
+
   it('should get a service', async () => {
     (vscode.commands.executeCommand as jest.Mock).mockResolvedValue(
       'mockService'

yarn.lock

@@ -375,23 +375,7 @@
     "@commitlint/rules" "^19.6.0"
     "@commitlint/types" "^19.5.0"
 
-"@commitlint/load@>6.1.1":
-  version "19.5.0"
-  resolved "https://registry.yarnpkg.com/@commitlint/load/-/load-19.5.0.tgz#67f90a294894d1f99b930b6152bed2df44a81794"
-  integrity sha512-INOUhkL/qaKqwcTUvCE8iIUf5XHsEPCLY9looJ/ipzi7jtGhgmtH7OOFiNvwYgH7mA8osUWOUDV8t4E2HAi4xA==
-  dependencies:
-    "@commitlint/config-validator" "^19.5.0"
-    "@commitlint/execute-rule" "^19.5.0"
-    "@commitlint/resolve-extends" "^19.5.0"
-    "@commitlint/types" "^19.5.0"
-    chalk "^5.3.0"
-    cosmiconfig "^9.0.0"
-    cosmiconfig-typescript-loader "^5.0.0"
-    lodash.isplainobject "^4.0.6"
-    lodash.merge "^4.6.2"
-    lodash.uniq "^4.5.0"
-
-"@commitlint/load@^19.6.1":
+"@commitlint/load@>6.1.1", "@commitlint/load@^19.6.1":
   version "19.6.1"
   resolved "https://registry.yarnpkg.com/@commitlint/load/-/load-19.6.1.tgz#5fae8843a6048a2d3d1cc16da0af8ee532fa9db4"
   integrity sha512-kE4mRKWWNju2QpsCWt428XBvUH55OET2N4QKQ0bF85qS/XbsRGG1MiTByDNlEVpEPceMkDr46LNH95DtRwcsfA==
@@ -1655,13 +1639,6 @@ core-util-is@~1.0.0:
   resolved "https://registry.yarnpkg.com/core-util-is/-/core-util-is-1.0.3.tgz#a6042d3634c2b27e9328f837b965fac83808db85"
   integrity sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ==
 
-cosmiconfig-typescript-loader@^5.0.0:
-  version "5.0.0"
-  resolved "https://registry.npmjs.org/cosmiconfig-typescript-loader/-/cosmiconfig-typescript-loader-5.0.0.tgz"
-  integrity sha512-+8cK7jRAReYkMwMiG+bxhcNKiHJDM6bR9FD/nGBXOWdMLuYawjF5cGrtLilJ+LGd3ZjCXnJjR5DkfWPoIVlqJA==
-  dependencies:
-    jiti "^1.19.1"
-
 cosmiconfig-typescript-loader@^6.1.0:
   version "6.1.0"
   resolved "https://registry.yarnpkg.com/cosmiconfig-typescript-loader/-/cosmiconfig-typescript-loader-6.1.0.tgz#7f644503e1c2bff90aed2d29a637008f279646bb"
@@ -3113,11 +3090,6 @@ jest@^29.7.0:
     import-local "^3.0.2"
     jest-cli "^29.7.0"
 
-jiti@^1.19.1:
-  version "1.21.0"
-  resolved "https://registry.npmjs.org/jiti/-/jiti-1.21.0.tgz"
-  integrity sha512-gFqAIbuKyyso/3G2qhiO2OM6shY6EPP/R0+mkDbyspxKazh8BXDC5FiFsUjlczgdNz/vfra0da2y+aHrusLG/Q==
-
 jiti@^2.4.1:
   version "2.4.2"
   resolved "https://registry.yarnpkg.com/jiti/-/jiti-2.4.2.tgz#d19b7732ebb6116b06e2038da74a55366faef560"