@memberjunction/skip-types 0.9.20 → 0.9.21

package/dist/types.d.ts

@@ -1,5 +1,56 @@
 import { DataContext } from '@memberjunction/data-context';
-export declare class SubProcessResponse {
+/**
+ * This type defines the shape of data that is passed back from the MJ API server to callers, typically the MJ Explorer UI
+ */
+export declare class MJAPISkipResult {
+    /**
+     * Indicates if the API request was successful or not, true if successful, false if not
+     */
+    Success: boolean;
+    /**
+     * Contains a more detailed status of the API request. This is typically used to provide additional information about the request, such as an error message if the request was not successful
+     */
+    Status: string;
+    /**
+     * The phase of the conversation, defined in the SkipResponsePhase type
+     */
+    ResponsePhase: SkipResponsePhase;
+    /**
+     * Contains the JSON data that is returned from the Skip API server.
+     * This can be a SkipAPIAnalysisCompleteResponse, SkipAPIClarifyingQuestionResponse, or SkipAPIDataRequestResponse.
+     * To determine which type it is and to access the properties of the response, you will need to typecast
+     * this property to the appropriate type. For example:
+     *
+     * if (result.ResponsePhase === 'analysis_complete') {
+     *    // typecast the MJAPISkipResult object Result property
+     *    const resultData = <SkipAPIAnalysisCompleteResponse>JSON.parse(result.Result);
+     *    // now you can access the properties of the SkipAPIAnalysisCompleteResponse type in a strongly typed manner
+     *    // and do whatever you want to do.
+     * }
+     */
+    Result: string;
+    /**
+     * The MemberJunction Conversation ID assigned to this conversation. This is used to track the
+     * conversation in the database, used for conversation history, and will be generated by the MJ API server if
+     * no existing Conversation ID was passed in with the request.
+     */
+    ConversationId: number;
+    /**
+     * The Conversation Detail ID for the inbound user message that was passed in with the request.
+     */
+    UserMessageConversationDetailId: number;
+    /**
+     * The Conversation Detail ID for the outbound system message that was generated by the Skip API server, stored in the database by the MJ API server,
+     * and is being passed back here.
+     */
+    AIMessageConversationDetailId: number;
+}
+/**
+ * Whenever Skip executes it's analysis phase, it uses a sandboxed sub-process to execute code securely and
+ * this shape of data is used to communicate the results of that sub-process back to the Skip API server.
+ * This data type is in turn used within the SkipAPIAnalysisCompleteResponse type.
+ */
+export declare class SkipSubProcessResponse {
     status: "success" | "error";
     resultType: "data" | "plot" | "html" | null;
     tableData: any[] | null;
@@ -8,11 +59,11 @@ export declare class SubProcessResponse {
         layout: any;
     } | null;
     htmlReport: string | null;
-    analysis: string | null;
     errorMessage: string | null;
 }
 /**
- * Defines the shape of the individual message that makes up the messages array that is passed back and forth with the Skip API Server
+ * Defines the shape of the individual message that makes up the messages array that is passed back and
+ * forth with the Skip API Server
  */
 export declare class SkipMessage {
     /**
@@ -24,6 +75,81 @@ export declare class SkipMessage {
      */
     content: string;
 }
+/**
+ * For each Skip API Analysis result, it is possible for Skip to provide a set of tableDataColumns that describe the data that is being returned in this shape.
+ */
+export declare class SkipColumnInfo {
+    fieldName: string;
+    displayName: string;
+    simpleDataType: 'string' | 'number' | 'date' | 'boolean';
+    description: string;
+}
+/**
+ * Describes the different request phases that are used to communicate with the Skip API Server
+ * The phase of the conversation, defined as follows:
+ * * initial_request: The initial request from the user - when a new conversation gets started or after a report is created, pass in this value
+ * * 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.
+ */
+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";
+};
+export type SkipRequestPhase = typeof SkipRequestPhase[keyof typeof SkipRequestPhase];
+export declare class SkipFieldInfo {
+    entityID: number;
+    sequence: number;
+    name: string;
+    displayName?: string;
+    description?: string;
+    isPrimaryKey: boolean;
+    isUnique: boolean;
+    category?: string;
+    type: string;
+    length: number;
+    precision: number;
+    scale: number;
+    allowsNull: boolean;
+    defaultValue: string;
+    autoIncrement: boolean;
+    valueListType?: string;
+    extendedType?: string;
+    defaultInView: boolean;
+    defaultColumnWidth: number;
+    isVirtual: boolean;
+    isNameField: boolean;
+    relatedEntityID?: number;
+    relatedEntityFieldName?: string;
+    relatedEntity?: string;
+    relatedEntitySchemaName?: string;
+    relatedEntityBaseView?: string;
+}
+export declare class SkipEntityRelationshipInfo {
+    entityID: number;
+    relatedEntityID: number;
+    type: string;
+    entityKeyField: string;
+    relatedEntityJoinField: string;
+    joinView: string;
+    joinEntityJoinField: string;
+    joinEntityInverseJoinField: string;
+    entity: string;
+    entityBaseView: string;
+    relatedEntity: string;
+    relatedEntityBaseView: string;
+}
+export declare class SkipEntityInfo {
+    id: number;
+    name: string;
+    description?: string;
+    schemaName: string;
+    baseView: string;
+    fields: SkipFieldInfo[];
+    relatedEntities: SkipEntityRelationshipInfo[];
+}
 /**
  * Defines the shape of the data that is expected by the Skip API Server when making a request
  */
@@ -38,6 +164,10 @@ export declare class SkipAPIRequest {
      * The data context, use this to provide all of the data you have in a data context to Skip. You should provide this from cache or refreshed based on the parameters provided by the user.
      */
     dataContext: DataContext;
+    /**
+     * Summary entity metadata that is passed into the Skip Server so that Skip has knowledge of the schema of the calling MJAPI environment
+     */
+    entityInfo: SkipEntityInfo[];
     /**
      * The conversation ID
      */
@@ -47,14 +177,23 @@ export declare class SkipAPIRequest {
      */
     organizationID: number;
     /**
-     * The phase of the conversation, defined as follows:
-     * * initial_request: The initial request from the user - when a new conversation gets started or after a report is created, pass in this value
-     * * 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.
+     * The request phase, defined within the SkipRequestPhase type
      */
-    requestPhase: 'initial_request' | 'clarify_question_response' | 'data_gathering_response' | 'data_gathering_failure';
+    requestPhase: SkipRequestPhase;
 }
+/**
+ * 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
+ * * clarifying_question: The Skip API server is asking for a clarifying question to be asked to the user - typecast the response to SkipAPIClarifyingQuestionResponse for all of the additional properties that are available in this response phase
+ * * data_request: The Skip API server is asking for additional data to be gathered - typecast the response to SkipAPIDataRequestResponse for all of the additional properties that are available in this response phase
+ * * analysis_complete: The Skip API server has completed the analysis and is providing the results - typecast the response to SkipAPIAnalysisCompleteResponse for all of the additional properties that are available in this response phase
+ */
+export declare const SkipResponsePhase: {
+    readonly clarifying_question: "clarifying_question";
+    readonly data_request: "data_request";
+    readonly analysis_complete: "analysis_complete";
+};
+export type SkipResponsePhase = typeof SkipResponsePhase[keyof typeof SkipResponsePhase];
 /**
  * Defines the shape of the data that is returned by the Skip API Server
  */
@@ -64,21 +203,23 @@ export declare class SkipAPIResponse {
      */
     success: boolean;
     /**
-     * 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
-     * * clarifying_question: The Skip API server is asking for a clarifying question to be asked to the user - typecast the response to SkipAPIClarifyingQuestionResponse for all of the additional properties that are available in this response phase
-     * * data_request: The Skip API server is asking for additional data to be gathered - typecast the response to SkipAPIDataRequestResponse for all of the additional properties that are available in this response phase
-     * * analysis_complete: The Skip API server has completed the analysis and is providing the results - typecast the response to SkipAPIAnalysisCompleteResponse for all of the additional properties that are available in this response phase
+     * The Skip API server response phase, defined within the SkipResponsePhase type
+     */
+    responsePhase: SkipResponsePhase;
+    /**
+     * An array of messages including the messaged passed in with the SkipAPIRequest object as well as
+     * any additional messages that Skip generates as part of the conversation.
      */
-    responsePhase: "clarifying_question" | "data_request" | "analysis_complete";
     messages: SkipMessage[];
 }
 /**
  * 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?: SubProcessResponse | null;
+    executionResults?: SkipSubProcessResponse | null;
     userExplanation?: string;
     techExplanation?: string;
+    tableDataColumns?: SkipColumnInfo[];
     suggestedQuestions?: string[] | null;
     reportTitle?: string | null;
     analysis?: string | null;
@@ -96,14 +237,24 @@ export declare class SkipAPIClarifyingQuestionResponse extends SkipAPIResponse {
 export declare class SkipAPIDataRequestResponse extends SkipAPIResponse {
     dataRequest: SkipDataRequest[];
 }
+/**
+ * Describes the different types of data requests the Skip API server can make for additional data.
+ * * sql: The Skip API server is asking for additional data to be gathered using a fully executable SQL statement
+ * * stored_query: The Skip API server is asking for additional data to be gathered using a stored query that is defined in the system within the Queries entity.
+ */
+export declare const SkipDataRequestType: {
+    readonly sql: "sql";
+    readonly stored_query: "stored_query";
+};
+export type SkipDataRequestType = typeof SkipDataRequestType[keyof typeof SkipDataRequestType];
 /**
  * This type is used to define the requested data whenever the Skip API server asks for additional data to be gathered
  */
 export declare class SkipDataRequest {
     /**
-     * The type of request, either "sql" or "stored_query". Stored query refers to the name of a query that is stored in the system and can be executed to gather data. SQL refers to a fully executable SQL statement that can be executed to gather data.
+     * The type of request, as defined in the `SkipDataRequestType` type
      */
-    type: "sql" | "stored_query";
+    type: SkipDataRequestType;
     /**
      * The text of the request - either a fully executable SQL statement or the name of a stored query
      */

package/dist/types.js

@@ -1,21 +1,78 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SkipDataRequest = exports.SkipAPIDataRequestResponse = exports.SkipAPIClarifyingQuestionResponse = exports.SkipAPIAnalysisCompleteResponse = exports.SkipAPIResponse = exports.SkipAPIRequest = exports.SkipMessage = exports.SubProcessResponse = void 0;
-class SubProcessResponse {
+exports.SkipDataRequest = exports.SkipDataRequestType = exports.SkipAPIDataRequestResponse = exports.SkipAPIClarifyingQuestionResponse = exports.SkipAPIAnalysisCompleteResponse = exports.SkipAPIResponse = exports.SkipResponsePhase = exports.SkipAPIRequest = exports.SkipEntityInfo = exports.SkipEntityRelationshipInfo = exports.SkipFieldInfo = 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
+ */
+class MJAPISkipResult {
+}
+exports.MJAPISkipResult = MJAPISkipResult;
+/**
+ * Whenever Skip executes it's analysis phase, it uses a sandboxed sub-process to execute code securely and
+ * this shape of data is used to communicate the results of that sub-process back to the Skip API server.
+ * This data type is in turn used within the SkipAPIAnalysisCompleteResponse type.
+ */
+class SkipSubProcessResponse {
 }
-exports.SubProcessResponse = SubProcessResponse;
+exports.SkipSubProcessResponse = SkipSubProcessResponse;
 /**
- * Defines the shape of the individual message that makes up the messages array that is passed back and forth with the Skip API Server
+ * Defines the shape of the individual message that makes up the messages array that is passed back and
+ * forth with the Skip API Server
  */
 class SkipMessage {
 }
 exports.SkipMessage = SkipMessage;
+/**
+ * For each Skip API Analysis result, it is possible for Skip to provide a set of tableDataColumns that describe the data that is being returned in this shape.
+ */
+class SkipColumnInfo {
+}
+exports.SkipColumnInfo = SkipColumnInfo;
+/**
+ * Describes the different request phases that are used to communicate with the Skip API Server
+ * The phase of the conversation, defined as follows:
+ * * initial_request: The initial request from the user - when a new conversation gets started or after a report is created, pass in this value
+ * * 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.
+ */
+exports.SkipRequestPhase = {
+    initial_request: 'initial_request',
+    clarify_question_response: 'clarify_question_response',
+    data_gathering_response: 'data_gathering_response',
+    data_gathering_failure: 'data_gathering_failure'
+};
+class SkipFieldInfo {
+}
+exports.SkipFieldInfo = SkipFieldInfo;
+class SkipEntityRelationshipInfo {
+}
+exports.SkipEntityRelationshipInfo = SkipEntityRelationshipInfo;
+class SkipEntityInfo {
+    constructor() {
+        this.fields = [];
+        this.relatedEntities = [];
+    }
+}
+exports.SkipEntityInfo = SkipEntityInfo;
 /**
  * Defines the shape of the data that is expected by the Skip API Server when making a request
  */
 class SkipAPIRequest {
 }
 exports.SkipAPIRequest = SkipAPIRequest;
+/**
+ * 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
+ * * clarifying_question: The Skip API server is asking for a clarifying question to be asked to the user - typecast the response to SkipAPIClarifyingQuestionResponse for all of the additional properties that are available in this response phase
+ * * data_request: The Skip API server is asking for additional data to be gathered - typecast the response to SkipAPIDataRequestResponse for all of the additional properties that are available in this response phase
+ * * analysis_complete: The Skip API server has completed the analysis and is providing the results - typecast the response to SkipAPIAnalysisCompleteResponse for all of the additional properties that are available in this response phase
+ */
+exports.SkipResponsePhase = {
+    clarifying_question: "clarifying_question",
+    data_request: "data_request",
+    analysis_complete: "analysis_complete"
+};
 /**
  * Defines the shape of the data that is returned by the Skip API Server
  */
@@ -40,6 +97,15 @@ exports.SkipAPIClarifyingQuestionResponse = SkipAPIClarifyingQuestionResponse;
 class SkipAPIDataRequestResponse extends SkipAPIResponse {
 }
 exports.SkipAPIDataRequestResponse = SkipAPIDataRequestResponse;
+/**
+ * Describes the different types of data requests the Skip API server can make for additional data.
+ * * sql: The Skip API server is asking for additional data to be gathered using a fully executable SQL statement
+ * * stored_query: The Skip API server is asking for additional data to be gathered using a stored query that is defined in the system within the Queries entity.
+ */
+exports.SkipDataRequestType = {
+    sql: "sql",
+    stored_query: "stored_query"
+};
 /**
  * This type is used to define the requested data whenever the Skip API server asks for additional data to be gathered
  */

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAIA,MAAa,kBAAkB;CAQ9B;AARD,gDAQC;AAGD;;GAEG;AACH,MAAa,WAAW;CASvB;AATD,kCASC;AAED;;GAEG;AACH,MAAa,cAAc;CA4B1B;AA5BD,wCA4BC;AAED;;GAEG;AACH,MAAa,eAAe;CAa3B;AAbD,0CAaC;AAED;;GAEG;AACH,MAAa,+BAAgC,SAAQ,eAAe;CAQnE;AARD,0EAQC;AAED;;GAEG;AACH,MAAa,iCAAkC,SAAQ,eAAe;CAErE;AAFD,8EAEC;AAED;;GAEG;AACH,MAAa,0BAA2B,SAAQ,eAAe;CAE9D;AAFD,gEAEC;AAED;;GAEG;AACH,MAAa,eAAe;CAa3B;AAbD,0CAaC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAIA;;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,aAAa;CA2BzB;AA3BD,sCA2BC;AAED,MAAa,0BAA0B;CAatC;AAbD,gEAaC;AAED,MAAa,cAAc;IAA3B;QAMI,WAAM,GAAmB,EAAE,CAAC;QAC5B,oBAAe,GAAiC,EAAE,CAAC;IACvD,CAAC;CAAA;AARD,wCAQC;AACD;;GAEG;AACH,MAAa,cAAc;CA4B1B;AA5BD,wCA4BC;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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/skip-types",
-  "version": "0.9.20",
+  "version": "0.9.21",
   "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",
@@ -20,6 +20,6 @@
   },
   "dependencies": {
     "@memberjunction/core-entities": "^0.9.125",
-    "@memberjunction/data-context": "^0.9.4"
+    "@memberjunction/data-context": "^0.9.5"
   }
 }