@adobe/spacecat-shared-gpt-client 1.4.6 → 1.5.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-gpt-client-v1.5.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-gpt-client-v1.4.7...@adobe/spacecat-shared-gpt-client-v1.5.0) (2025-02-17)
+
+
+### Features
+
+* add Client to interact with Genvar APIs ([#596](https://github.com/adobe/spacecat-shared/issues/596)) ([cd69beb](https://github.com/adobe/spacecat-shared/commit/cd69beb153b543c59f70ea702c0d0c72c458515d))
+
+# [@adobe/spacecat-shared-gpt-client-v1.4.7](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-gpt-client-v1.4.6...@adobe/spacecat-shared-gpt-client-v1.4.7) (2025-02-16)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#603](https://github.com/adobe/spacecat-shared/issues/603)) ([b58d4c7](https://github.com/adobe/spacecat-shared/commit/b58d4c7237fb2522bba9b722e9eed7b0ae9e5f70))
+
 # [@adobe/spacecat-shared-gpt-client-v1.4.6](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-gpt-client-v1.4.5...@adobe/spacecat-shared-gpt-client-v1.4.6) (2025-02-08)
 
 

package/README.md

@@ -1,8 +1,9 @@
 # Spacecat Shared - GPT Client
 
+## Firefall
 The `FirefallClient` library offers a streamlined way to interact with the Firefall API, enabling applications to fetch insights, recommendations, and codes based on provided prompts. Designed with simplicity and efficiency in mind, this client handles all aspects of communication with the Firefall API, including request authentication, error handling, and response parsing.
 
-## Configuration
+### Configuration
 
 To use the `FirefallClient`, you need to configure it with the following parameters:
 
@@ -24,9 +25,9 @@ Additionally, the configuration for the `@adobe/spacecat-shared-ims-client` libr
 - `IMS_CLIENT_CODE`: Your IMS client code, used for authentication.
 - `IMS_CLIENT_SECRET`: Your IMS client secret, used for authentication.
 
-## Usage Examples
+### Usage Examples
 
-### Instantiating the Firefall Client
+#### Instantiating the Firefall Client
 
 ```javascript
 import FirefallClient from 'path/to/firefall-client';
@@ -45,9 +46,9 @@ try {
 }
 ```
 
-### Fetching Insights
+#### Fetching Insights
 
-#### Via Capability Execution endpoint
+1.  Via Capability Execution endpoint
 
 ```javascript
 /**
@@ -78,7 +79,7 @@ async function fetchInsights(prompt) {
 fetchInsights('How can we improve customer satisfaction?');
 ```
 
-#### Via Chat Completions endpoint
+2.  Via Chat Completions endpoint
 
 ```javascript
 /**
@@ -115,6 +116,78 @@ fetchCompletions('Identify all food items in this image', { imageUrls: ['data:im
 
 Ensure that you replace `'path/to/firefall-client'` with the actual path to the `FirefallClient` class in your project and adjust the configuration parameters according to your Firefall API credentials.
 
+## Genvar Client
+
+The `Genvar client` library provides a convenient way to interact with the Genvar APIs.
+
+### Configuration
+To use the `GenvarClient`, you need to configure it with the following parameters:
+
+- `GENVAR_HOST`: The hostname for Genvar API.
+- `GENVAR_IMS_ORG_ID`: The IMS ORG ID to use when calling the Genvar APIs and tracking the request.
+
+These parameters can be set through environment variables or passed directly to the `GenvarClient.createFrom` method.
+
+Additionally, the configuration for the `@adobe/spacecat-shared-ims-client` library is required to fetch the service access token from the IMS API:
+
+- `IMS_HOST`: The hostname of the IMS API.
+- `IMS_CLIENT_ID`: Your IMS client ID.
+- `IMS_CLIENT_CODE`: Your IMS client code, used for authentication.
+- `IMS_CLIENT_SECRET`: Your IMS client secret, used for authentication.
+
+### Usage Examples
+
+#### Instantiating the Genvar Client
+```javascript
+import GenvarClient from 'path/to/genvar-client';
+
+// Assuming environment variables are set
+const context = {
+  env: process.env,
+  log: console, // Using console for logging in this example
+};
+
+try {
+  const client = GenvarClient.createFrom(context);
+  console.log('GenvarClient created successfully.');
+} catch (error) {
+  console.error('Error creating GenvarClient:', error.message);
+}
+```
+
+#### Calling Genvar API
+
+- Using `generateSuggestions` method which first submits the job and then polls the job status
+```javascript
+/**
+ *  Call Genvar API with generate suggestions method 
+ */
+async function generateAISuggestions() {
+  try {
+    const client = GenvarClient.createFrom({
+      env: {
+        GENVAR_HOST: 'https://12345-genvarapi-seotest.adobeioruntime.net',
+        GENVAR_IMS_ORG_ID: 'abcd@AdobeOrg',
+        IMS_HOST: 'ims.example.com',
+        IMS_CLIENT_ID: 'yourClientId',
+        IMS_CLIENT_CODE: 'yourClientCode',
+        IMS_CLIENT_SECRET: 'yourClientSecret',
+      },
+      log: console,
+    });
+
+    const requestBody = {
+      param1: 'some-value',
+    };
+    const endpoint = '/some-endpoint';
+    const response = await client.generateSuggestions(requestBody, endpoint);
+    console.log('Genvar API response:', response);
+  } catch (error) {
+    console.error('Failed to call genvar API:', error.message);
+  }
+}
+```
+
 ## Testing
 
 To run tests:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-gpt-client",
-  "version": "1.4.6",
+  "version": "1.5.0",
   "description": "Shared modules of the Spacecat Services - GPT Client",
   "type": "module",
   "engines": {
@@ -40,7 +40,7 @@
     "@adobe/spacecat-shared-utils": "1.26.4"
   },
   "devDependencies": {
-    "chai": "5.1.2",
+    "chai": "5.2.0",
     "chai-as-promised": "8.0.1",
     "nock": "14.0.1",
     "sinon": "19.0.2",

package/src/clients/genvar-client.js

@@ -0,0 +1,182 @@
+/*
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import { createUrl } from '@adobe/fetch';
+import { ImsClient } from '@adobe/spacecat-shared-ims-client';
+import {
+  hasText, isNonEmptyObject,
+  isValidUrl,
+  tracingFetch,
+} from '@adobe/spacecat-shared-utils';
+
+export default class GenvarClient {
+  static createFrom(context) {
+    const { log = console } = context;
+    const imsClient = ImsClient.createFrom(context);
+    const {
+      GENVAR_HOST: genvarHost,
+      GENVAR_IMS_ORG_ID: genvarImsOrgId,
+      GENVAR_API_POLL_INTERVAL: pollInterval = 3000,
+    } = context.env;
+
+    if (!isValidUrl(genvarHost)) {
+      throw new Error('Missing Genvar API endpoint');
+    }
+
+    if (!hasText(genvarImsOrgId)) {
+      throw new Error('Missing Genvar Ims org');
+    }
+
+    return new GenvarClient({
+      genvarHost,
+      imsClient,
+      imsOrg: genvarImsOrgId,
+      pollInterval,
+    }, log);
+  }
+
+  /**
+   * Creates a new Genvar client
+   *
+   * @param {Object} config - The configuration object.
+   * @param {string} config.apiEndpoint - The API endpoint for Genvar.
+   * @param {ImsClient} config.imsClient - The IMS Client.
+   * @param {string} config.imsOrg - The IMS Org for Genvar.
+   * @param {number} config.pollInterval - The interval to poll for job status.
+   * @param {Object} log - The Logger.
+   * @returns {GenvarClient} - the Genvar client.
+   */
+  constructor(config, log) {
+    this.config = config;
+    this.log = log;
+    this.imsClient = config.imsClient;
+    this.apiAuth = null;
+  }
+
+  async #getApiAuth() {
+    if (!this.apiAuth) {
+      this.apiAuth = (await this.imsClient.getServiceAccessToken()).access_token;
+    }
+    return this.apiAuth;
+  }
+
+  #logDuration(message, startTime) {
+    const endTime = process.hrtime.bigint();
+    const duration = (endTime - startTime) / BigInt(1e6);
+    this.log.debug(`${message}: took ${duration}ms`);
+  }
+
+  async #submitJob(body, path) {
+    const apiAuth = await this.#getApiAuth();
+    const url = createUrl(`${this.config.genvarHost}${path}`);
+    const headers = {
+      'Content-Type': 'application/json',
+      Authorization: `Bearer ${apiAuth}`,
+      'x-gw-ims-org-id': this.config.imsOrg,
+    };
+
+    this.log.info(`[Genvar API Call] URL: ${url}, Headers: ${JSON.stringify({ ...headers, Authorization: '***' })}`);
+
+    let response;
+    let responseJsonObj;
+    try {
+      response = await tracingFetch(url, {
+        method: 'POST',
+        headers,
+        body,
+      });
+      if (!response.ok) {
+        const errorMessage = await response.text();
+        throw new Error(`Job submission failed with status code ${response.status} and error: ${errorMessage}`);
+      }
+      responseJsonObj = await response.json();
+    } catch (err) {
+      this.log.error(`Genvar Job submit failed with error: ${err.message}`);
+      throw err;
+    }
+    return responseJsonObj;
+  }
+
+  /* eslint-disable no-await-in-loop */
+  async #pollJobStatus(jobId, path) {
+    const apiAuth = await this.#getApiAuth();
+    let jobStatusResponse;
+    do {
+      await new Promise(
+        (resolve) => { setTimeout(resolve, this.config.pollInterval); },
+      ); // Wait for 3 seconds(default) before polling
+
+      const url = `${this.config.genvarHost}${path}?jobId=${jobId}`;
+      const headers = {
+        Authorization: `Bearer ${apiAuth}`,
+        'x-gw-ims-org-id': this.config.imsOrg,
+      };
+
+      this.log.info(`[Genvar API Call] URL: ${url}, Headers: ${JSON.stringify({ ...headers, Authorization: '***' })}`);
+
+      let response;
+      try {
+        response = await tracingFetch(
+          createUrl(url),
+          {
+            method: 'GET',
+            headers,
+          },
+        );
+        if (!response.ok) {
+          throw new Error(`Job polling failed with status code ${response.status}`);
+        }
+        jobStatusResponse = await response.json();
+      } catch (err) {
+        this.log.error(`Genvar Job poll failed with error: ${err.message}`);
+        throw err;
+      }
+    } while (jobStatusResponse.status === 'running');
+
+    if (jobStatusResponse.status !== 'completed') {
+      throw new Error(`Job did not succeed, status: ${jobStatusResponse.status}.\n${JSON.stringify(jobStatusResponse, null, 2)}`);
+    }
+
+    return jobStatusResponse;
+  }
+
+  /**
+   * Fetches data from Genvar API. Follows the flow: submit job and polls job status
+   * @param body The request body to provide to Genvar
+   * @param path The Genvar request path
+   * @returns {string} - API Response
+   */
+  async generateSuggestions(body, path) {
+    if (!body) {
+      throw new Error('Invalid body received');
+    }
+    if (!path) {
+      throw new Error('Invalid path received');
+    }
+    try {
+      const startTime = process.hrtime.bigint();
+
+      const jobSubmissionResponse = await this.#submitJob(body, path);
+      const jobStatusResponse = await this.#pollJobStatus(jobSubmissionResponse.jobId, path);
+      this.#logDuration('Genvar API Execution call took ms: ', startTime);
+
+      const { result } = jobStatusResponse;
+      if (!isNonEmptyObject(result)) {
+        throw new Error('Job completed but no output was found');
+      }
+      return result;
+    } catch (error) {
+      this.log.error('Error while calling Genvar API: ', error.message);
+      throw error;
+    }
+  }
+}

package/src/index.d.ts

@@ -11,7 +11,9 @@
  */
 
 import type { FirefallClient } from './clients';
+import GenvarClient from './clients/genvar-client.js';
 
 export {
   FirefallClient,
+  GenvarClient,
 };

package/src/index.js

@@ -11,7 +11,9 @@
  */
 
 import FirefallClient from './clients/firefall-client.js';
+import GenvarClient from './clients/genvar-client.js';
 
 export {
   FirefallClient,
+  GenvarClient,
 };