@memberjunction/skip-types 0.9.50 → 0.9.51

package/dist/types.d.ts

@@ -268,24 +268,76 @@ export declare class SkipAPIResponse {
      */
     messages: SkipMessage[];
 }
+/**
+ * Defines an individual filter that will be used to filter the data in the view to the specific row or rows that the user clicked on for a drill down
+ */
+export declare class SkipAPIAnalysisDrillDownFilter {
+    reportFieldName: string;
+    viewFieldName: string;
+}
+/**
+ * Defines the filtering information necessary for a reporting UI to enable behavior to drill down when a user clicks on a portion of a report like an element of a chart or a row in a table
+ */
+export declare class SkipAPIAnalysisDrillDown {
+    /**
+     * The name of the view in the database that we should drill into whenever a user clicks on an element in the report
+     */
+    viewName: string;
+    /**
+     * One or more filters that are used to filter the data in the view to the specific row or rows that the user clicked on
+     */
+    filters: SkipAPIAnalysisDrillDownFilter[];
+}
 /**
  * Defines the shape of the data that is returned by the Skip API Server when the responsePhase is 'analysis_complete'
  */
 export declare class SkipAPIAnalysisCompleteResponse extends SkipAPIResponse {
     executionResults?: SkipSubProcessResponse | null;
+    /**
+     * A user-friendly explanation of what the report does
+     */
     userExplanation?: string;
+    /**
+     * A more detailed technical explanation of what the report does and how it works
+     */
     techExplanation?: string;
+    /**
+     * Describes each column in the report's computed data output that is what is displayed in either a table or a chart
+     */
     tableDataColumns?: SkipColumnInfo[];
+    /**
+     * Zero or more suggested questions that the AI engine suggests might be good follow up questions to ask after reviewing the provided report
+     */
     suggestedQuestions?: string[] | null;
+    /**
+     * The title of the report
+     */
     reportTitle?: string | null;
+    /**
+     * An analysis of the report, the data and the formatted report output.
+     */
     analysis?: string | null;
+    /**
+     * Information that will support a drill-down experience in the reporting UI
+     */
+    drillDown?: SkipAPIAnalysisDrillDown | null;
+    /**
+     * The script text that was used to generated the report and can be saved to be run again later
+     */
     scriptText?: string | null;
 }
 /**
  * Defines the shape of the data that is returned by the Skip API Server when the responsePhase is 'clarifying_question'
  */
 export declare class SkipAPIClarifyingQuestionResponse extends SkipAPIResponse {
+    /**
+     * The question to display to the user from the AI model after a request is made to the AI when the AI needs more information to process the request
+     */
     clarifyingQuestion: string;
+    /**
+     * Zero or more suggested prompts that the AI model suggests might be good responses to the clarifying question
+     */
+    suggestedPrompts: string[];
 }
 /**
  * Defines the shape of the data that is returned by the Skip API Server when the responsePhase is 'data_request'

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.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.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
  */
@@ -91,6 +91,18 @@ exports.SkipResponsePhase = {
 class SkipAPIResponse {
 }
 exports.SkipAPIResponse = SkipAPIResponse;
+/**
+ * Defines an individual filter that will be used to filter the data in the view to the specific row or rows that the user clicked on for a drill down
+ */
+class SkipAPIAnalysisDrillDownFilter {
+}
+exports.SkipAPIAnalysisDrillDownFilter = SkipAPIAnalysisDrillDownFilter;
+/**
+ * Defines the filtering information necessary for a reporting UI to enable behavior to drill down when a user clicks on a portion of a report like an element of a chart or a row in a table
+ */
+class SkipAPIAnalysisDrillDown {
+}
+exports.SkipAPIAnalysisDrillDown = SkipAPIAnalysisDrillDown;
 /**
  * Defines the shape of the data that is returned by the Skip API Server when the responsePhase is 'analysis_complete'
  */

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,+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,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;CASpC;AATD,4DASC;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.50",
+  "version": "0.9.51",
   "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.147",
-    "@memberjunction/data-context": "^0.9.33"
+    "@memberjunction/core-entities": "^0.9.148",
+    "@memberjunction/data-context": "^0.9.34"
   }
 }