@memberjunction/skip-types 0.9.30 → 0.9.32

package/dist/types.d.ts

@@ -91,12 +91,14 @@ export declare class SkipColumnInfo {
  * * clarify_question_response: Sometimes the Skip API server responds back to your request with a responsePhase of 'clarifying_question' - in this situation, the MJAPI server needs to communicate with the UI to ask the follow up question to the user. When you have that feedback from the user gathered and are providing the response to the clarifying question back to Skip API, use this requestPhase
  * * data_gathering_response: Sometimes the Skip API server responds back to your request with a responsePhase of 'data_request' - in this situation, the MJAPI server needs to process the data request, gather whatever additional data the Skip API has asked for, and then return it in the dataContext property of the SkipAPIRequest object. When you are finished gathering data and returning it to the Skip API server, use this requestPhase
  * * data_gathering_failure: When you send an API request to the Skip API server saying there was a data_gathering_failure that means that you attempted to retrieve data Skip requested but there was (typically) an error in the SQL statement that Skip generated and it needs to be regenerated. The MJAPI server code handles this scenario automatically.
+ * * run_existing_script: Use this to run an existing script that was already processed. When this option is used, the script provided is run and the results are provided in the response.
  */
 export declare const SkipRequestPhase: {
     readonly initial_request: "initial_request";
     readonly clarify_question_response: "clarify_question_response";
     readonly data_gathering_response: "data_gathering_response";
     readonly data_gathering_failure: "data_gathering_failure";
+    readonly run_existing_script: "run_existing_script";
 };
 export type SkipRequestPhase = typeof SkipRequestPhase[keyof typeof SkipRequestPhase];
 export declare class SkipEntityFieldInfo {
@@ -224,6 +226,12 @@ export declare class SkipAPIRequest {
      */
     requestPhase: SkipRequestPhase;
 }
+export declare class SkipAPIRunScriptRequest extends SkipAPIRequest {
+    /**
+     * The script text to run
+     */
+    scriptText: string;
+}
 /**
  * Describes the different response phases that are used by the Skip API Server to respond back to the caller (usually the MJAPI server but can be anyone)
  * The response phase indicates if the Skip API server is asking for additional data, a clarifying question, or if the analysis is complete and the information has been provided

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.SkipAPIResponse = exports.SkipResponsePhase = 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.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;
 /**
  * This type defines the shape of data that is passed back from the MJ API server to callers, typically the MJ Explorer UI
  */
@@ -35,12 +35,14 @@ exports.SkipColumnInfo = SkipColumnInfo;
  * * clarify_question_response: Sometimes the Skip API server responds back to your request with a responsePhase of 'clarifying_question' - in this situation, the MJAPI server needs to communicate with the UI to ask the follow up question to the user. When you have that feedback from the user gathered and are providing the response to the clarifying question back to Skip API, use this requestPhase
  * * data_gathering_response: Sometimes the Skip API server responds back to your request with a responsePhase of 'data_request' - in this situation, the MJAPI server needs to process the data request, gather whatever additional data the Skip API has asked for, and then return it in the dataContext property of the SkipAPIRequest object. When you are finished gathering data and returning it to the Skip API server, use this requestPhase
  * * data_gathering_failure: When you send an API request to the Skip API server saying there was a data_gathering_failure that means that you attempted to retrieve data Skip requested but there was (typically) an error in the SQL statement that Skip generated and it needs to be regenerated. The MJAPI server code handles this scenario automatically.
+ * * run_existing_script: Use this to run an existing script that was already processed. When this option is used, the script provided is run and the results are provided in the response.
  */
 exports.SkipRequestPhase = {
     initial_request: 'initial_request',
     clarify_question_response: 'clarify_question_response',
     data_gathering_response: 'data_gathering_response',
-    data_gathering_failure: 'data_gathering_failure'
+    data_gathering_failure: 'data_gathering_failure',
+    run_existing_script: 'run_existing_script'
 };
 class SkipEntityFieldInfo {
 }
@@ -67,6 +69,9 @@ exports.SkipQueryFieldInfo = SkipQueryFieldInfo;
 class SkipAPIRequest {
 }
 exports.SkipAPIRequest = SkipAPIRequest;
+class SkipAPIRunScriptRequest extends SkipAPIRequest {
+}
+exports.SkipAPIRunScriptRequest = SkipAPIRunScriptRequest;
 /**
  * Describes the different response phases that are used by the Skip API Server to respond back to the caller (usually the MJAPI server but can be anyone)
  * The response phase indicates if the Skip API server is asking for additional data, a clarifying question, or if the analysis is complete and the information has been provided

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;;;;;;;GAOG;AACU,QAAA,gBAAgB,GAAG;IAC5B,eAAe,EAAE,iBAAiB;IAClC,yBAAyB,EAAE,2BAA2B;IACtD,uBAAuB,EAAE,yBAAyB;IAClD,sBAAsB,EAAE,wBAAwB;CAC1C,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;AAGD;;;;;;GAMG;AACU,QAAA,iBAAiB,GAAG;IAC7B,mBAAmB,EAAE,qBAAqB;IAC1C,YAAY,EAAE,cAAc;IAC5B,iBAAiB,EAAE,mBAAmB;CAChC,CAAC;AAIX;;GAEG;AACH,MAAa,eAAe;CAc3B;AAdD,0CAcC;AAED;;GAEG;AACH,MAAa,+BAAgC,SAAQ,eAAe;CASnE;AATD,0EASC;AAED;;GAEG;AACH,MAAa,iCAAkC,SAAQ,eAAe;CAErE;AAFD,8EAEC;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;AAED;;GAEG;AACH,MAAa,cAAc;CAiC1B;AAjCD,wCAiCC;AAED,MAAa,uBAAwB,SAAQ,cAAc;CAK1D;AALD,0DAKC;AAED;;;;;;GAMG;AACU,QAAA,iBAAiB,GAAG;IAC7B,mBAAmB,EAAE,qBAAqB;IAC1C,YAAY,EAAE,cAAc;IAC5B,iBAAiB,EAAE,mBAAmB;CAChC,CAAC;AAIX;;GAEG;AACH,MAAa,eAAe;CAc3B;AAdD,0CAcC;AAED;;GAEG;AACH,MAAa,+BAAgC,SAAQ,eAAe;CASnE;AATD,0EASC;AAED;;GAEG;AACH,MAAa,iCAAkC,SAAQ,eAAe;CAErE;AAFD,8EAEC;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.30",
+  "version": "0.9.32",
   "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",
@@ -19,7 +19,7 @@
     "typescript": "^5.3.3"
   },
   "dependencies": {
-    "@memberjunction/core-entities": "^0.9.129",
-    "@memberjunction/data-context": "^0.9.16"
+    "@memberjunction/core-entities": "^0.9.130",
+    "@memberjunction/data-context": "^0.9.17"
   }
 }