@salesforce/agents 0.9.4 → 0.9.5-preview.0

package/lib/agentPreview.d.ts

@@ -0,0 +1,61 @@
+import { Connection } from '@salesforce/core';
+type ApiStatus = {
+    status: 'UP' | 'DOWN';
+};
+type Href = {
+    href: string;
+};
+type Links = {
+    self: Href | null;
+    messages: Href | null;
+    session: Href | null;
+    end: Href | null;
+};
+type Message = {
+    type: string;
+    id: string;
+    feedbackId: string;
+    planId: string;
+    isContentSafe: boolean;
+    message: string;
+    result: {
+        type: string;
+        property: string;
+        value: any;
+    };
+    citedReferences: {
+        type: string;
+        value: string;
+    };
+};
+type StartResponse = {
+    sessionId: string;
+    _links: Links;
+    messages: Message[];
+};
+type SendResponse = {
+    messages: Message[];
+    _links: Links;
+};
+type EndResponse = {
+    messages: {
+        type: string;
+        id: string;
+        reason: string;
+        feedbackId: string;
+    };
+    _links: Links;
+};
+type EndReason = 'UserRequest' | 'Transfer' | 'Expiration' | 'Error' | 'Other';
+export declare class AgentPreview {
+    private got;
+    private headers;
+    private instanceUrl;
+    private tempApiBase;
+    constructor(connection: Connection);
+    start(botId: string): Promise<StartResponse>;
+    send(sessionId: string, message: string): Promise<SendResponse>;
+    end(sessionId: string, reason: EndReason): Promise<EndResponse>;
+    status(): Promise<ApiStatus>;
+}
+export {};

package/lib/agentPreview.js

@@ -0,0 +1,71 @@
+"use strict";
+/*
+ * Copyright (c) 2024, 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentPreview = void 0;
+const request_preview_1 = require("./request-preview");
+class AgentPreview {
+    got;
+    headers;
+    instanceUrl;
+    tempApiBase = process.env.AFDX_TEMP_AGENT_API_BASE;
+    constructor(connection) {
+        this.got = new request_preview_1.RequestPreview();
+        const auth = process.env.AFDX_TEMP_AGENT_API_KEY;
+        const env = process.env.AFDX_TEMP_AGENT_ENV;
+        this.instanceUrl = connection.instanceUrl;
+        this.headers = {
+            'x-sfdc-tenant-id': `core/${env}/${connection.getAuthInfoFields().orgId}`,
+            'x-salesforce-region': process.env.AFDX_TEMP_AGENT_REGION,
+            Accept: 'application/json',
+            'Content-Type': 'application/json',
+            Authorization: `API_KEY ${auth}`,
+        };
+    }
+    async start(botId) {
+        const url = `${this.tempApiBase}/einstein/ai-agent/v1/agents/${botId}/sessions`;
+        const body = {
+            // TODO: this needs to generate a unique guid
+            externalSessionKey: '44736288-030b-4080-b477-975a60f00a12',
+            instanceConfig: {
+                endpoint: `${this.instanceUrl}/`,
+            },
+            streamingCapabilities: {
+                chunkTypes: ['Text'],
+            },
+            variables: [],
+        };
+        return this.got.request('POST', url, body, this.headers);
+    }
+    async send(sessionId, message) {
+        const url = `${this.tempApiBase}/einstein/ai-agent/v1/sessions/${sessionId}/messages`;
+        const body = {
+            message: {
+                sequenceId: Date.now(),
+                type: 'Text',
+                text: message,
+            },
+            variables: [],
+        };
+        return this.got.request('POST', url, body, this.headers);
+    }
+    async end(sessionId, reason) {
+        const url = `${this.tempApiBase}/einstein/ai-agent/v1/sessions/${sessionId}`;
+        return this.got.request('DELETE', url, undefined, {
+            ...this.headers,
+            'x-session-end-reason': reason,
+        });
+    }
+    // Get the status of the Agent API (UP | DOWN)
+    async status() {
+        const base = 'https://test.api.salesforce.com';
+        const url = `${base}/einstein/ai-agent/v1/status`;
+        return this.got.request('GET', url, undefined, this.headers);
+    }
+}
+exports.AgentPreview = AgentPreview;
+//# sourceMappingURL=agentPreview.js.map

package/lib/agentPreview.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agentPreview.js","sourceRoot":"","sources":["../src/agentPreview.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAGH,uDAAmD;AAyDnD,MAAa,YAAY;IACf,GAAG,CAAiB;IACpB,OAAO,CAAC;IACR,WAAW,CAAS;IACpB,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,wBAAkC,CAAC;IAErE,YAAmB,UAAsB;QACvC,IAAI,CAAC,GAAG,GAAG,IAAI,gCAAc,EAAE,CAAC;QAChC,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAiC,CAAC;QAC3D,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,mBAA6B,CAAC;QAEtD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;QAE1C,IAAI,CAAC,OAAO,GAAG;YACb,kBAAkB,EAAE,QAAQ,GAAG,IAAI,UAAU,CAAC,iBAAiB,EAAE,CAAC,KAAe,EAAE;YACnF,qBAAqB,EAAE,OAAO,CAAC,GAAG,CAAC,sBAAgC;YACnE,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,WAAW,IAAI,EAAE;SACjC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,KAAa;QAC9B,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,WAAW,gCAAgC,KAAK,WAAW,CAAC;QAEhF,MAAM,IAAI,GAAG;YACX,6CAA6C;YAC7C,kBAAkB,EAAE,sCAAsC;YAC1D,cAAc,EAAE;gBACd,QAAQ,EAAE,GAAG,IAAI,CAAC,WAAW,GAAG;aACjC;YACD,qBAAqB,EAAE;gBACrB,UAAU,EAAE,CAAC,MAAM,CAAC;aACrB;YACD,SAAS,EAAE,EAAE;SACd,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAgB,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC1E,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,SAAiB,EAAE,OAAe;QAClD,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,WAAW,kCAAkC,SAAS,WAAW,CAAC;QAEtF,MAAM,IAAI,GAAG;YACX,OAAO,EAAE;gBACP,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE;gBACtB,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,OAAO;aACd;YACD,SAAS,EAAE,EAAE;SACd,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAe,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACzE,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,SAAiB,EAAE,MAAiB;QACnD,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,WAAW,kCAAkC,SAAS,EAAE,CAAC;QAE7E,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAc,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE;YAC7D,GAAG,IAAI,CAAC,OAAO;YACf,sBAAsB,EAAE,MAAM;SAC/B,CAAC,CAAC;IACL,CAAC;IAED,8CAA8C;IACvC,KAAK,CAAC,MAAM;QACjB,MAAM,IAAI,GAAG,iCAAiC,CAAC;QAC/C,MAAM,GAAG,GAAG,GAAG,IAAI,8BAA8B,CAAC;QAElD,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAY,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF;AAvED,oCAuEC"}

package/lib/index.d.ts

@@ -1,3 +1,4 @@
 export { type AgentCreateConfig, type AgentCreateConfigV2, type AgentCreateResponse, type AgentCreateResponseV2, type AgentJobSpec, type AgentJobSpecV2, type AgentJobSpecCreateConfig, type AgentJobSpecCreateConfigV2, type AgentJobSpecCreateResponse, type DraftAgentTopics, type DraftAgentTopicsBody, type DraftAgentTopicsResponse, SfAgent, } from './types';
 export { Agent, AgentCreateLifecycleStages, AgentCreateLifecycleStagesV2, generateAgentApiName } from './agent';
 export { AgentTester, convertTestResultsToFormat, generateTestSpec, AgentTestCreateLifecycleStages, type AvailableDefinition, type AgentTestResultsResponse, type AgentTestStartResponse, type AgentTestStatusResponse, type TestCaseResult, type TestStatus, } from './agentTester';
+export { AgentPreview } from './agentPreview';

package/lib/index.js

@@ -6,7 +6,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AgentTestCreateLifecycleStages = exports.generateTestSpec = exports.convertTestResultsToFormat = exports.AgentTester = exports.generateAgentApiName = exports.AgentCreateLifecycleStagesV2 = exports.AgentCreateLifecycleStages = exports.Agent = void 0;
+exports.AgentPreview = exports.AgentTestCreateLifecycleStages = exports.generateTestSpec = exports.convertTestResultsToFormat = exports.AgentTester = exports.generateAgentApiName = exports.AgentCreateLifecycleStagesV2 = exports.AgentCreateLifecycleStages = exports.Agent = void 0;
 var agent_1 = require("./agent");
 Object.defineProperty(exports, "Agent", { enumerable: true, get: function () { return agent_1.Agent; } });
 Object.defineProperty(exports, "AgentCreateLifecycleStages", { enumerable: true, get: function () { return agent_1.AgentCreateLifecycleStages; } });
@@ -17,4 +17,6 @@ Object.defineProperty(exports, "AgentTester", { enumerable: true, get: function
 Object.defineProperty(exports, "convertTestResultsToFormat", { enumerable: true, get: function () { return agentTester_1.convertTestResultsToFormat; } });
 Object.defineProperty(exports, "generateTestSpec", { enumerable: true, get: function () { return agentTester_1.generateTestSpec; } });
 Object.defineProperty(exports, "AgentTestCreateLifecycleStages", { enumerable: true, get: function () { return agentTester_1.AgentTestCreateLifecycleStages; } });
+var agentPreview_1 = require("./agentPreview");
+Object.defineProperty(exports, "AgentPreview", { enumerable: true, get: function () { return agentPreview_1.AgentPreview; } });
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAiBH,iCAAgH;AAAvG,8FAAA,KAAK,OAAA;AAAE,mHAAA,0BAA0B,OAAA;AAAE,qHAAA,4BAA4B,OAAA;AAAE,6GAAA,oBAAoB,OAAA;AAC9F,6CAWuB;AAVrB,0GAAA,WAAW,OAAA;AACX,yHAAA,0BAA0B,OAAA;AAC1B,+GAAA,gBAAgB,OAAA;AAChB,6HAAA,8BAA8B,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAiBH,iCAAgH;AAAvG,8FAAA,KAAK,OAAA;AAAE,mHAAA,0BAA0B,OAAA;AAAE,qHAAA,4BAA4B,OAAA;AAAE,6GAAA,oBAAoB,OAAA;AAC9F,6CAWuB;AAVrB,0GAAA,WAAW,OAAA;AACX,yHAAA,0BAA0B,OAAA;AAC1B,+GAAA,gBAAgB,OAAA;AAChB,6HAAA,8BAA8B,OAAA;AAQhC,+CAA8C;AAArC,4GAAA,YAAY,OAAA"}

package/lib/request-preview.d.ts

@@ -0,0 +1,5 @@
+export declare class RequestPreview {
+    private logger;
+    constructor();
+    request<Response>(method: 'GET' | 'POST' | 'DELETE', url: string, body: Record<string, unknown> | undefined, headers?: Record<string, string>): Promise<Response>;
+}

package/lib/request-preview.js

@@ -0,0 +1,39 @@
+"use strict";
+/*
+ * Copyright (c) 2024, 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
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestPreview = void 0;
+const core_1 = require("@salesforce/core");
+const got_1 = __importDefault(require("got"));
+class RequestPreview {
+    logger;
+    constructor() {
+        this.logger = core_1.Logger.childFromRoot(this.constructor.name);
+    }
+    async request(method, url, body, headers) {
+        this.logger.debug(`Making ${method} request to ${url}`);
+        switch (method) {
+            case 'GET':
+                return got_1.default.get(url, { headers }).json();
+            case 'POST':
+                if (!body) {
+                    throw core_1.SfError.create({
+                        name: 'InvalidBody',
+                        message: 'POST requests must include a body',
+                    });
+                }
+                return got_1.default.post(url, { headers, json: body }).json();
+            case 'DELETE':
+                return got_1.default.delete(url, { headers }).json();
+        }
+    }
+}
+exports.RequestPreview = RequestPreview;
+//# sourceMappingURL=request-preview.js.map

package/lib/request-preview.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-preview.js","sourceRoot":"","sources":["../src/request-preview.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAEH,2CAAmD;AACnD,8CAAsB;AAEtB,MAAa,cAAc;IACjB,MAAM,CAAS;IAEvB;QACE,IAAI,CAAC,MAAM,GAAG,aAAM,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC5D,CAAC;IAEM,KAAK,CAAC,OAAO,CAClB,MAAiC,EACjC,GAAW,EACX,IAAyC,EACzC,OAAgC;QAEhC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,MAAM,eAAe,GAAG,EAAE,CAAC,CAAC;QAExD,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,KAAK;gBACR,OAAO,aAAG,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YAC1C,KAAK,MAAM;gBACT,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,MAAM,cAAO,CAAC,MAAM,CAAC;wBACnB,IAAI,EAAE,aAAa;wBACnB,OAAO,EAAE,mCAAmC;qBAC7C,CAAC,CAAC;gBACL,CAAC;gBACD,OAAO,aAAG,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YACvD,KAAK,QAAQ;gBACX,OAAO,aAAG,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAC/C,CAAC;IACH,CAAC;CACF;AA9BD,wCA8BC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/agents",
   "description": "Client side APIs for working with Salesforce agents",
-  "version": "0.9.4",
+  "version": "0.9.5-preview.0",
   "license": "BSD-3-Clause",
   "author": "Salesforce",
   "main": "lib/index",
@@ -17,6 +17,7 @@
     "@salesforce/source-deploy-retrieve": "^12.14.1",
     "ansis": "^3.10.0",
     "fast-xml-parser": "^4.5.1",
+    "got": "^11.8.6",
     "nock": "^13.5.6",
     "yaml": "^2.7.0"
   },