@memberjunction/skip-types 0.9.54 → 0.9.55

package/dist/types.d.ts

@@ -191,6 +191,19 @@ export declare class SkipQueryFieldInfo {
     updatedAt: Date;
     sourceEntity: string;
 }
+export declare class SkipAPIRequestAPIKey {
+    /**
+     * These are the supported LLM vendors that Skip can use. These driver names map to the
+     * registered classes in the MemberJunction AI namespace for example the @memberjunction/ai-openai package includes
+     * a class called OpenAILLM that is registered with the MemberJunction AI system as a valid sub-class of BaseLLM
+     */
+    vendorDriverName: 'OpenAILLM' | 'MistralLLM' | 'GeminiLLM' | 'AnthropicLLM';
+    /**
+     * This is the actual API key for the specified vendor.
+     * NOTE: Skip NEVER stores this information, it is only used to make requests to the AI vendor of choice
+     */
+    apiKey: string;
+}
 /**
  * Defines the shape of the data that is expected by the Skip API Server when making a request
  */
@@ -225,6 +238,11 @@ export declare class SkipAPIRequest {
      * The request phase, defined within the SkipRequestPhase type
      */
     requestPhase: SkipRequestPhase;
+    /**
+     * One or more API keys that are used for AI systems that Skip will access on behalf of the API caller
+     * NOTE: This is not where you put in the bearer token for the Skip API server itself, that goes in the header of the request
+     */
+    apiKeys: SkipAPIRequestAPIKey[];
 }
 export declare class SkipAPIRunScriptRequest extends SkipAPIRequest {
     /**

package/dist/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SkipDataRequest = exports.SkipDataRequestType = exports.SkipAPIDataRequestResponse = exports.SkipAPIClarifyingQuestionResponse = exports.SkipAPIAnalysisCompleteResponse = exports.SkipAPIAnalysisDrillDown = exports.SkipAPIAnalysisDrillDownFilter = exports.SkipAPIResponse = exports.SkipResponsePhase = exports.SkipAPIRunScriptRequest = exports.SkipAPIRequest = exports.SkipQueryFieldInfo = exports.SkipQueryInfo = exports.SkipEntityInfo = exports.SkipEntityRelationshipInfo = exports.SkipEntityFieldInfo = exports.SkipRequestPhase = exports.SkipColumnInfo = exports.SkipMessage = exports.SkipSubProcessResponse = exports.MJAPISkipResult = void 0;
+exports.SkipDataRequest = exports.SkipDataRequestType = exports.SkipAPIDataRequestResponse = exports.SkipAPIClarifyingQuestionResponse = exports.SkipAPIAnalysisCompleteResponse = exports.SkipAPIAnalysisDrillDown = exports.SkipAPIAnalysisDrillDownFilter = exports.SkipAPIResponse = exports.SkipResponsePhase = exports.SkipAPIRunScriptRequest = exports.SkipAPIRequest = exports.SkipAPIRequestAPIKey = exports.SkipQueryFieldInfo = exports.SkipQueryInfo = exports.SkipEntityInfo = exports.SkipEntityRelationshipInfo = exports.SkipEntityFieldInfo = exports.SkipRequestPhase = exports.SkipColumnInfo = exports.SkipMessage = exports.SkipSubProcessResponse = exports.MJAPISkipResult = void 0;
 /**
  * This type defines the shape of data that is passed back from the MJ API server to callers, typically the MJ Explorer UI
  */
@@ -63,6 +63,9 @@ exports.SkipQueryInfo = SkipQueryInfo;
 class SkipQueryFieldInfo {
 }
 exports.SkipQueryFieldInfo = SkipQueryFieldInfo;
+class SkipAPIRequestAPIKey {
+}
+exports.SkipAPIRequestAPIKey = SkipAPIRequestAPIKey;
 /**
  * Defines the shape of the data that is expected by the Skip API Server when making a request
  */

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,MAAa,eAAe;CAgD3B;AAhDD,0CAgDC;AAGD;;;;GAIG;AACH,MAAa,sBAAsB;CAOlC;AAPD,wDAOC;AAGD;;;GAGG;AACH,MAAa,WAAW;CASvB;AATD,kCASC;AAID;;GAEG;AACH,MAAa,cAAc;CAK1B;AALD,wCAKC;AAGD;;;;;;;;GAQG;AACU,QAAA,gBAAgB,GAAG;IAC5B,eAAe,EAAE,iBAAiB;IAClC,yBAAyB,EAAE,2BAA2B;IACtD,uBAAuB,EAAE,yBAAyB;IAClD,sBAAsB,EAAE,wBAAwB;IAChD,mBAAmB,EAAE,qBAAqB;CACpC,CAAC;AAGX,MAAa,mBAAmB;CA4B/B;AA5BD,kDA4BC;AAED,MAAa,0BAA0B;CAatC;AAbD,gEAaC;AAED,MAAa,cAAc;IAA3B;QAMI,WAAM,GAAyB,EAAE,CAAC;QAClC,oBAAe,GAAiC,EAAE,CAAC;IACvD,CAAC;CAAA;AARD,wCAQC;AAED,MAAa,aAAa;CAczB;AAdD,sCAcC;AACD,MAAa,kBAAkB;CAsB9B;AAtBD,gDAsBC;AAED;;GAEG;AACH,MAAa,cAAc;CAiC1B;AAjCD,wCAiCC;AAED,MAAa,uBAAwB,SAAQ,cAAc;CAK1D;AALD,0DAKC;AAED;;;;;;GAMG;AACU,QAAA,iBAAiB,GAAG;IAC7B,aAAa,EAAE,eAAe;IAC9B,mBAAmB,EAAE,qBAAqB;IAC1C,YAAY,EAAE,cAAc;IAC5B,iBAAiB,EAAE,mBAAmB;CAChC,CAAC;AAIX;;GAEG;AACH,MAAa,eAAe;CAkB3B;AAlBD,0CAkBC;AAED;;GAEG;AACH,MAAa,8BAA8B;CAG1C;AAHD,wEAGC;AAED;;GAEG;AACH,MAAa,wBAAwB;CAepC;AAfD,4DAeC;AAED;;GAEG;AACH,MAAa,+BAAgC,SAAQ,eAAe;CAkCnE;AAlCD,0EAkCC;AAED;;GAEG;AACH,MAAa,iCAAkC,SAAQ,eAAe;CASrE;AATD,8EASC;AAED;;GAEG;AACH,MAAa,0BAA2B,SAAQ,eAAe;CAE9D;AAFD,gEAEC;AAGD;;;;GAIG;AACU,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,KAAK;IACV,YAAY,EAAE,cAAc;CACtB,CAAC;AAIX;;GAEG;AACH,MAAa,eAAe;CAa3B;AAbD,0CAaC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,MAAa,eAAe;CAgD3B;AAhDD,0CAgDC;AAGD;;;;GAIG;AACH,MAAa,sBAAsB;CAOlC;AAPD,wDAOC;AAGD;;;GAGG;AACH,MAAa,WAAW;CASvB;AATD,kCASC;AAID;;GAEG;AACH,MAAa,cAAc;CAK1B;AALD,wCAKC;AAGD;;;;;;;;GAQG;AACU,QAAA,gBAAgB,GAAG;IAC5B,eAAe,EAAE,iBAAiB;IAClC,yBAAyB,EAAE,2BAA2B;IACtD,uBAAuB,EAAE,yBAAyB;IAClD,sBAAsB,EAAE,wBAAwB;IAChD,mBAAmB,EAAE,qBAAqB;CACpC,CAAC;AAGX,MAAa,mBAAmB;CA4B/B;AA5BD,kDA4BC;AAED,MAAa,0BAA0B;CAatC;AAbD,gEAaC;AAED,MAAa,cAAc;IAA3B;QAMI,WAAM,GAAyB,EAAE,CAAC;QAClC,oBAAe,GAAiC,EAAE,CAAC;IACvD,CAAC;CAAA;AARD,wCAQC;AAED,MAAa,aAAa;CAczB;AAdD,sCAcC;AACD,MAAa,kBAAkB;CAsB9B;AAtBD,gDAsBC;AAGD,MAAa,oBAAoB;CAYhC;AAZD,oDAYC;AAED;;GAEG;AACH,MAAa,cAAc;CAuC1B;AAvCD,wCAuCC;AAED,MAAa,uBAAwB,SAAQ,cAAc;CAK1D;AALD,0DAKC;AAED;;;;;;GAMG;AACU,QAAA,iBAAiB,GAAG;IAC7B,aAAa,EAAE,eAAe;IAC9B,mBAAmB,EAAE,qBAAqB;IAC1C,YAAY,EAAE,cAAc;IAC5B,iBAAiB,EAAE,mBAAmB;CAChC,CAAC;AAIX;;GAEG;AACH,MAAa,eAAe;CAkB3B;AAlBD,0CAkBC;AAED;;GAEG;AACH,MAAa,8BAA8B;CAG1C;AAHD,wEAGC;AAED;;GAEG;AACH,MAAa,wBAAwB;CAepC;AAfD,4DAeC;AAED;;GAEG;AACH,MAAa,+BAAgC,SAAQ,eAAe;CAkCnE;AAlCD,0EAkCC;AAED;;GAEG;AACH,MAAa,iCAAkC,SAAQ,eAAe;CASrE;AATD,8EASC;AAED;;GAEG;AACH,MAAa,0BAA2B,SAAQ,eAAe;CAE9D;AAFD,gEAEC;AAGD;;;;GAIG;AACU,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,KAAK;IACV,YAAY,EAAE,cAAc;CACtB,CAAC;AAIX;;GAEG;AACH,MAAa,eAAe;CAa3B;AAbD,0CAaC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/skip-types",
-  "version": "0.9.54",
+  "version": "0.9.55",
   "description": "MemberJunction: Skip AI Assistant - Types that are used between the MJAPI and the Skip API as well as the UI within MemberJunction Explorer",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",