@memberjunction/skip-types 2.43.0 → 2.45.0

package/dist/agent-types.d.ts

@@ -0,0 +1,251 @@
+/**
+ * @fileoverview AI Agent and learning cycle types for Skip API
+ *
+ * This file contains types related to AI agent functionality, learning cycles, and
+ * human-in-the-loop interactions within the Skip API system. These types define the structure for:
+ *
+ * - Agent notes and note types (SkipAPIAgentNote, SkipAPIAgentNoteType)
+ * - Agent requests for human approval/feedback (SkipAPIAgentRequest)
+ * - Learning cycle processes (SkipAPILearningCycleRequest, SkipAPILearningCycleResponse)
+ * - Change tracking for learning cycles (various SkipLearningCycle*Change types)
+ *
+ * The learning cycle functionality allows Skip to analyze conversation history and improve
+ * its performance over time by generating notes, updating queries, and creating agent
+ * requests based on patterns it discovers in user interactions.
+ *
+ * Agent requests enable human-in-the-loop workflows where Skip can ask for approval or
+ * guidance on specific actions, ensuring that AI decisions align with organizational
+ * policies and user preferences.
+ *
+ * Notes provide a way for Skip to store and retrieve organizational knowledge, user
+ * preferences, and contextual information that improves future interactions.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+import type { SkipConversation } from './conversation-types';
+import type { SkipEntityInfo } from './entity-metadata-types';
+import type { SkipQueryInfo, SkipLearningCycleQueryChange } from './query-types';
+import type { SkipAPIRequestAPIKey } from './auth-types';
+/**
+ * Type that defines a possible note type from the source system that invoked Skip
+ */
+export declare class SkipAPIAgentNoteType {
+    id: string;
+    name: string;
+    description: string;
+}
+/**
+ * Defines the shape of an individual Agent note that is stored in MJ that can be passed to Skip for additional context.
+ */
+export declare class SkipAPIAgentNote {
+    /**
+     * Unique identifier for the note
+     */
+    id: string;
+    /**
+     * Unique type id (UUID) for the note type, maps to a SkipAPIAgentNoteType that was passed in the SkipAPIRequest
+     */
+    agentNoteTypeId: string;
+    /**
+     * Text name for the note type
+     */
+    agentNoteType: string;
+    /**
+     * Date/Time the note was initially created
+     */
+    createdAt: Date;
+    /**
+     * Date/Time the note was last updated
+     */
+    updatedAt: Date;
+    /**
+     * The text of the note
+     */
+    note: string;
+    /**
+     * This type field contains the scope of the note, either Global or User
+     */
+    type: 'User' | 'Global';
+    /**
+     * The unique identifier for the user that the note is associated with, only populated if type === 'User'
+     */
+    userId: string | null;
+    /**
+     * The name of the user that the note is associated with, only populated if type === 'User'
+     */
+    user: string | null;
+}
+/**
+ * Whenever an agent is interested in getting human-in-the-loop style feedback/approval, this type is used
+ */
+export declare class SkipAPIAgentRequest {
+    /**
+     * The unique identifier for the request
+     */
+    id: string;
+    /**
+     * The unique identifier for the agent that made the request
+     */
+    agentId: string;
+    /**
+     * The name of the agent that made the request
+     */
+    agent: string;
+    /**
+     * The date and time the request was made
+     */
+    requestedAt: Date;
+    /**
+     * Optional, the unique identifier for the user that the request was made for by the Agent
+     */
+    requestForUserId?: string;
+    /**
+     * Only populated if the request was made for a user, the name of the user that the request was made for
+     */
+    requestForUser?: string;
+    /**
+     * Status of the request: 'Requested' | 'Approved' | 'Rejected' | 'Canceled'
+     */
+    status: 'Requested' | 'Approved' | 'Rejected' | 'Canceled';
+    /**
+     * Text body of the request the AI Agent is making
+     */
+    request: string;
+    /**
+     * Text body of the response that is being sent back to the AI Agent
+     */
+    response: string;
+    /**
+     * The unique identifier for the user that responded to the request
+     */
+    responseByUserId: string;
+    /**
+     * The name of the user that responded to the request
+     */
+    responseByUser: string;
+    /**
+     * The date and time the user responded to the request
+     */
+    respondedAt: Date;
+    /**
+     * Internal comments that are not intended to be shared with the AI Agent
+     */
+    comments: string;
+    /**
+     * The date and time the request record was created in the database
+     */
+    createdAt: Date;
+    /**
+     * The date and time the request record was last updated in the database
+     */
+    updatedAt: Date;
+}
+/**
+ * Represents a change to agent notes during the learning cycle process, allowing Skip
+ * to add new notes, update existing ones, or mark notes for deletion based on
+ * its analysis of conversation patterns and organizational learning.
+ */
+export declare class SkipLearningCycleNoteChange {
+    note: SkipAPIAgentNote;
+    changeType: 'add' | 'update' | 'delete';
+}
+/**
+ * Represents a change to agent requests during the learning cycle process, allowing Skip
+ * to add new requests, update existing ones, or mark requests for deletion based on
+ * its analysis of conversation patterns and user feedback.
+ */
+export declare class SkipLearningCycleRequestChange {
+    request: SkipAPIAgentRequest;
+    changeType: 'add' | 'update' | 'delete';
+}
+/**
+ * API Request shape to ask the /learn end point to learn from conversation history and pass back "notes" that can be stored in the database for future requests
+ */
+export declare class SkipAPILearningCycleRequest {
+    /**
+     * OrganizationID for Skip to identify the organization
+     */
+    organizationId: string;
+    /**
+     * This is an optional string parameter where you can tell Skip anything you'd like to share about your organization, structure, database schema, and anything else
+     * that might be helpful for him to be aware of. Keep in mind that this organizationInfo will be incorprorated into every request Skip makes to the underlying AI
+     * services which can add cost and processing time to your requests. Including this information is extremely helpful as a very simple method of
+     * contextualizing Skip for your organization. In the Pro and above Skip plans, there are far more granular and effect methods of training Skip beyond this organizationInfo parameter, contact
+     * the team at MemberJunction.com for more information if you're interested.
+     */
+    organizationInfo?: string;
+    /**
+    * Learning Cycle ID is a unique identifier from the MJ AI Agent Learning Cycles table that will track the details of the API calls and the results for logging purposes and
+    * also to track the timestamps for each run to batch the conversations that are being sent
+    */
+    learningCycleId: string;
+    /**
+     * An array of conversations that have taken place since the last learning cycle
+     */
+    newConversations: SkipConversation[];
+    /**
+     * Summary entity metadata that is passed into the Skip Server so that Skip has knowledge of the schema of the calling MJAPI environment
+     */
+    entities: SkipEntityInfo[];
+    /**
+     * Stored queries in the MJ metadata that Skip can use and learn from
+     */
+    queries: SkipQueryInfo[];
+    /**
+     * An array of notes that have been generated by the Skip API server during the learning cycle process in the past
+     */
+    notes: SkipAPIAgentNote[];
+    /**
+     * An array of the possible note types that can be stored in the source MJ system
+     */
+    noteTypes: SkipAPIAgentNoteType[];
+    /**
+     * An array of the requests that Skip has previously made. Full history provided including requests of all status conditions.
+     */
+    requests: SkipAPIAgentRequest[];
+    /**
+     * Optional, the date/time of the last learning cycle performed on this dataset
+     */
+    lastLearningCycleDate: Date;
+    /**
+     * 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[];
+}
+/**
+ * API Response shape to ask the /learn end point to learn from conversation history and pass back "notes", an array of notes are provided that should be stored in the database
+ * to then be passed into future Skip API requests for analysis/etc.
+ */
+export declare class SkipAPILearningCycleResponse {
+    /**
+     * Indicates if the learning cycle was successful or not
+     */
+    success: boolean;
+    /**
+     * If a learning cycle is skipped because there is no new conversation data to learn from, this property will be set to true
+     */
+    learningCycleSkipped?: boolean;
+    /**
+     * If the learning cycle was not successful, this property will contain an error message that describes the reason for the failure
+     */
+    error?: string;
+    /**
+     * The number of milliseconds that have elapsed since the learning cycle process started
+     */
+    elapsedTime: number;
+    /**
+     * The notes that were generated by the Skip API server during the learning cycle process
+     */
+    noteChanges: SkipLearningCycleNoteChange[];
+    /**
+     * This provides an array of changes requested by Skip to the MJ database for queries, adding, updating and/or deleting.
+     */
+    queryChanges: SkipLearningCycleQueryChange[];
+    /**
+     * This array should be populated by the agent with any changes to requests - deleting existing requests that have not been responded to yet and for whatever reason are not relevant anymore, updating existing requests that haven't yet been responded to, and adding new requests to help the agent learn.
+     */
+    requestChanges: SkipLearningCycleRequestChange[];
+}
+//# sourceMappingURL=agent-types.d.ts.map

package/dist/agent-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent-types.d.ts","sourceRoot":"","sources":["../src/agent-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,4BAA4B,EAAE,MAAM,eAAe,CAAC;AACjF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEzD;;GAEG;AACH,qBAAa,oBAAoB;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,qBAAa,gBAAgB;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,SAAS,EAAE,IAAI,CAAC;IAChB;;OAEG;IACH,SAAS,EAAE,IAAI,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IACxB;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,qBAAa,mBAAmB;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC;IAClB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,CAAC;IAC3D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,IAAI,CAAC;IAChB;;OAEG;IACH,SAAS,EAAE,IAAI,CAAC;CACnB;AAED;;;;GAIG;AACH,qBAAa,2BAA2B;IACpC,IAAI,EAAE,gBAAgB,CAAC;IACvB,UAAU,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;CAC3C;AAED;;;;GAIG;AACH,qBAAa,8BAA8B;IACvC,OAAO,EAAE,mBAAmB,CAAC;IAC7B,UAAU,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;CAC3C;AAED;;GAEG;AACH,qBAAa,2BAA2B;IACpC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAA;IAEtB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAEzB;;;MAGE;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,EAAE,CAAC;IAErC;;OAEG;IACH,QAAQ,EAAE,cAAc,EAAE,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,aAAa,EAAE,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,gBAAgB,EAAE,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,oBAAoB,EAAE,CAAC;IAElC;;OAEG;IACH,QAAQ,EAAE,mBAAmB,EAAE,CAAC;IAEhC;;OAEG;IACH,qBAAqB,EAAE,IAAI,CAAC;IAE5B;;;OAGG;IACH,OAAO,EAAE,oBAAoB,EAAE,CAAC;CACnC;AAED;;;GAGG;AACH,qBAAa,4BAA4B;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,2BAA2B,EAAE,CAAC;IAE3C;;OAEG;IACH,YAAY,EAAE,4BAA4B,EAAE,CAAC;IAE7C;;OAEG;IACH,cAAc,EAAE,8BAA8B,EAAE,CAAC;CACpD"}

package/dist/agent-types.js

@@ -0,0 +1,76 @@
+"use strict";
+/**
+ * @fileoverview AI Agent and learning cycle types for Skip API
+ *
+ * This file contains types related to AI agent functionality, learning cycles, and
+ * human-in-the-loop interactions within the Skip API system. These types define the structure for:
+ *
+ * - Agent notes and note types (SkipAPIAgentNote, SkipAPIAgentNoteType)
+ * - Agent requests for human approval/feedback (SkipAPIAgentRequest)
+ * - Learning cycle processes (SkipAPILearningCycleRequest, SkipAPILearningCycleResponse)
+ * - Change tracking for learning cycles (various SkipLearningCycle*Change types)
+ *
+ * The learning cycle functionality allows Skip to analyze conversation history and improve
+ * its performance over time by generating notes, updating queries, and creating agent
+ * requests based on patterns it discovers in user interactions.
+ *
+ * Agent requests enable human-in-the-loop workflows where Skip can ask for approval or
+ * guidance on specific actions, ensuring that AI decisions align with organizational
+ * policies and user preferences.
+ *
+ * Notes provide a way for Skip to store and retrieve organizational knowledge, user
+ * preferences, and contextual information that improves future interactions.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SkipAPILearningCycleResponse = exports.SkipAPILearningCycleRequest = exports.SkipLearningCycleRequestChange = exports.SkipLearningCycleNoteChange = exports.SkipAPIAgentRequest = exports.SkipAPIAgentNote = exports.SkipAPIAgentNoteType = void 0;
+/**
+ * Type that defines a possible note type from the source system that invoked Skip
+ */
+class SkipAPIAgentNoteType {
+}
+exports.SkipAPIAgentNoteType = SkipAPIAgentNoteType;
+/**
+ * Defines the shape of an individual Agent note that is stored in MJ that can be passed to Skip for additional context.
+ */
+class SkipAPIAgentNote {
+}
+exports.SkipAPIAgentNote = SkipAPIAgentNote;
+/**
+ * Whenever an agent is interested in getting human-in-the-loop style feedback/approval, this type is used
+ */
+class SkipAPIAgentRequest {
+}
+exports.SkipAPIAgentRequest = SkipAPIAgentRequest;
+/**
+ * Represents a change to agent notes during the learning cycle process, allowing Skip
+ * to add new notes, update existing ones, or mark notes for deletion based on
+ * its analysis of conversation patterns and organizational learning.
+ */
+class SkipLearningCycleNoteChange {
+}
+exports.SkipLearningCycleNoteChange = SkipLearningCycleNoteChange;
+/**
+ * Represents a change to agent requests during the learning cycle process, allowing Skip
+ * to add new requests, update existing ones, or mark requests for deletion based on
+ * its analysis of conversation patterns and user feedback.
+ */
+class SkipLearningCycleRequestChange {
+}
+exports.SkipLearningCycleRequestChange = SkipLearningCycleRequestChange;
+/**
+ * API Request shape to ask the /learn end point to learn from conversation history and pass back "notes" that can be stored in the database for future requests
+ */
+class SkipAPILearningCycleRequest {
+}
+exports.SkipAPILearningCycleRequest = SkipAPILearningCycleRequest;
+/**
+ * API Response shape to ask the /learn end point to learn from conversation history and pass back "notes", an array of notes are provided that should be stored in the database
+ * to then be passed into future Skip API requests for analysis/etc.
+ */
+class SkipAPILearningCycleResponse {
+}
+exports.SkipAPILearningCycleResponse = SkipAPILearningCycleResponse;
+//# sourceMappingURL=agent-types.js.map

package/dist/agent-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent-types.js","sourceRoot":"","sources":["../src/agent-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;;;AAOH;;GAEG;AACH,MAAa,oBAAoB;CAIhC;AAJD,oDAIC;AAED;;GAEG;AACH,MAAa,gBAAgB;CAqC5B;AArCD,4CAqCC;AAED;;GAEG;AACH,MAAa,mBAAmB;CA8D/B;AA9DD,kDA8DC;AAED;;;;GAIG;AACH,MAAa,2BAA2B;CAGvC;AAHD,kEAGC;AAED;;;;GAIG;AACH,MAAa,8BAA8B;CAG1C;AAHD,wEAGC;AAED;;GAEG;AACH,MAAa,2BAA2B;CA6DvC;AA7DD,kEA6DC;AAED;;;GAGG;AACH,MAAa,4BAA4B;CAmCxC;AAnCD,oEAmCC"}

package/dist/api-types.d.ts

@@ -0,0 +1,212 @@
+/**
+ * @fileoverview Core API types for Skip API communication
+ *
+ * This file contains the fundamental API request and response types used for communication
+ * between client applications and the Skip API server. These types define the core data
+ * structures for:
+ *
+ * - Main API requests and responses (SkipAPIRequest, SkipAPIResponse)
+ * - API result wrapper for MJ API server responses (MJAPISkipResult)
+ * - Request and response phase enumerations
+ * - Special API request types (SkipAPIRunScriptRequest)
+ *
+ * These types form the foundation of the Skip API communication protocol and are used
+ * across all Skip API interactions regardless of the specific functionality being invoked.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+import { DataContext } from '@memberjunction/data-context';
+import type { SkipMessage } from './conversation-types';
+import type { SkipEntityInfo } from './entity-metadata-types';
+import type { SkipQueryInfo } from './query-types';
+import type { SkipAPIRequestAPIKey } from './auth-types';
+import type { SkipAPIArtifact } from './artifact-types';
+import type { SkipAPIAgentNote, SkipAPIAgentNoteType } from './agent-types';
+/**
+ * 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.
+ * * 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.
+ * * chat_with_a_record: This is used for the simple record chatting feature that is separate from other Skip API features. This is used for having a chat conversation with Skip about a specific record in the database that the user is typically looking at in a UI.
+ */
+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";
+    readonly chat_with_a_record: "chat_with_a_record";
+};
+export type SkipRequestPhase = typeof SkipRequestPhase[keyof typeof 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
+ * * chat_with_a_record_complete: The Skip API server has completed the chat with a record and is providing the results - typecast the response to SkipAPIChatWithRecordResponse for all of the additional properties that are available in this response phase
+ */
+export declare const SkipResponsePhase: {
+    readonly status_update: "status_update";
+    readonly clarifying_question: "clarifying_question";
+    readonly data_request: "data_request";
+    readonly analysis_complete: "analysis_complete";
+    readonly chat_with_a_record_complete: "chat_with_a_record_complete";
+};
+export type SkipResponsePhase = typeof SkipResponsePhase[keyof typeof SkipResponsePhase];
+/**
+ * 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: string;
+    /**
+     * The Conversation Detail ID for the inbound user message that was passed in with the request.
+     */
+    UserMessageConversationDetailId: string;
+    /**
+     * 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: string;
+}
+/**
+ * Defines the shape of the data that is expected by the Skip API Server when making a request
+ */
+export declare class SkipAPIRequest {
+    /**
+     * An array of 1 or more messages that are part of the conversation. The Skip API server will use these messages to understand the context of the conversation.
+     * When Skip responds to a request, he provides a messages array as well that will include the input messages as well as additional messages that he has generated as part of the conversation.
+     * In future requests for the same conversation it is important to include ALL of the messages that have been part of the conversation so far, so that Skip can understand the full context of the conversation.
+     */
+    messages: SkipMessage[];
+    /**
+     * This is an optional string parameter where you can tell Skip anything you'd like to share about your organization, structure, database schema, and anything else
+     * that might be helpful for him to be aware of. Keep in mind that this organizationInfo will be incorprorated into every request Skip makes to the underlying AI
+     * services which can add cost and processing time to your requests. Including this information is extremely helpful as a very simple method of
+     * contextualizing Skip for your organization. In the Pro and above Skip plans, there are far more granular and effect methods of training Skip beyond this organizationInfo parameter, contact
+     * the team at MemberJunction.com for more information if you're interested.
+     */
+    organizationInfo?: string;
+    /**
+     * 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
+     */
+    entities: SkipEntityInfo[];
+    /**
+     * Stored queries in the MJ metadata that Skip can use and learn from
+     */
+    queries: SkipQueryInfo[];
+    /**
+     * The conversation ID
+     */
+    conversationID: string;
+    /**
+     * The organization ID - this is part of the Skip API Authentication Request, along with the bearer token in the header (the bearer token is not yet implemented, To-Do!)
+     */
+    organizationID: string;
+    /**
+     * 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[];
+    /**
+     * Optional, array of artifacts that already exist for the given conversation.
+     */
+    artifacts?: SkipAPIArtifact[];
+    /**
+     * Optional notes that can be passed to Skip for additional context
+     */
+    notes?: SkipAPIAgentNote[];
+    /**
+     * Optional, list of the possible types of notes that an agent can store in the source MJ system
+     */
+    noteTypes?: SkipAPIAgentNoteType[];
+    /**
+     * Optional, if the calling server wants to enable the AI agent to call back to interact and request data or otherwise, this is the URL that the AI agent can use to call back to the source server
+     */
+    callingServerURL?: string;
+    /**
+     * Optional, if the calling server wants to enable the AI agent to call back to interact and request data or otherwise, this is the API key that the AI agent can use to call back to the source server
+     */
+    callingServerAPIKey?: string;
+    /**
+     * Optional, if the calling server requires the use of an additional short-lived access token beyond the API key, this is the token that the AI agent can use to call back to the source server during the lifecycle
+     * of the request
+     */
+    callingServerAccessToken?: string;
+}
+/**
+ * Defines the shape of the data that is returned by the Skip API Server
+ */
+export declare class SkipAPIResponse {
+    /**
+     * Used for all response phases, to indicate if the API request was successful or not
+     */
+    success: boolean;
+    /**
+     * This property is only used if success is false, and contains an error message that describes the reason for the failure
+     */
+    error: string;
+    /**
+     * 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.
+     */
+    messages: SkipMessage[];
+}
+/**
+ * Special API request type that extends the base SkipAPIRequest to include script execution capabilities.
+ * Used when the requestPhase is 'run_existing_script' to execute pre-defined script text.
+ */
+export declare class SkipAPIRunScriptRequest extends SkipAPIRequest {
+    /**
+     * The script text to run
+     */
+    scriptText: string;
+}
+//# sourceMappingURL=api-types.d.ts.map

package/dist/api-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-types.d.ts","sourceRoot":"","sources":["../src/api-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAE5E;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB;;;;;;;CAOnB,CAAC;AACX,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAEtF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB;;;;;;CAMpB,CAAC;AACX,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAC;AAEzF;;GAEG;AACH,qBAAa,eAAe;IACxB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAC;IAEjC;;;;;;;;;;;;OAYG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,+BAA+B,EAAE,MAAM,CAAC;IAExC;;;OAGG;IACH,6BAA6B,EAAE,MAAM,CAAC;CACzC;AAED;;GAEG;AACH,qBAAa,cAAc;IACvB;;;;OAIG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAC;IAExB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB;;OAEG;IACH,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B;;OAEG;IACH,OAAO,EAAE,aAAa,EAAE,CAAC;IAEzB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,gBAAgB,CAAC;IAE/B;;;OAGG;IACH,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAEhC;;OAEG;IACH,SAAS,CAAC,EAAE,eAAe,EAAE,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAEnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAA;CACpC;AAED;;GAEG;AACH,qBAAa,eAAe;IACxB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAC;IACjC;;;OAGG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAC;CAC3B;AAED;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,cAAc;IACvD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACtB"}

package/dist/api-types.js

@@ -0,0 +1,80 @@
+"use strict";
+/**
+ * @fileoverview Core API types for Skip API communication
+ *
+ * This file contains the fundamental API request and response types used for communication
+ * between client applications and the Skip API server. These types define the core data
+ * structures for:
+ *
+ * - Main API requests and responses (SkipAPIRequest, SkipAPIResponse)
+ * - API result wrapper for MJ API server responses (MJAPISkipResult)
+ * - Request and response phase enumerations
+ * - Special API request types (SkipAPIRunScriptRequest)
+ *
+ * These types form the foundation of the Skip API communication protocol and are used
+ * across all Skip API interactions regardless of the specific functionality being invoked.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SkipAPIRunScriptRequest = exports.SkipAPIResponse = exports.SkipAPIRequest = exports.MJAPISkipResult = exports.SkipResponsePhase = exports.SkipRequestPhase = void 0;
+/**
+ * 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.
+ * * 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.
+ * * chat_with_a_record: This is used for the simple record chatting feature that is separate from other Skip API features. This is used for having a chat conversation with Skip about a specific record in the database that the user is typically looking at in a UI.
+ */
+exports.SkipRequestPhase = {
+    initial_request: 'initial_request',
+    clarify_question_response: 'clarify_question_response',
+    data_gathering_response: 'data_gathering_response',
+    data_gathering_failure: 'data_gathering_failure',
+    run_existing_script: 'run_existing_script',
+    chat_with_a_record: 'chat_with_a_record'
+};
+/**
+ * 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
+ * * chat_with_a_record_complete: The Skip API server has completed the chat with a record and is providing the results - typecast the response to SkipAPIChatWithRecordResponse for all of the additional properties that are available in this response phase
+ */
+exports.SkipResponsePhase = {
+    status_update: "status_update",
+    clarifying_question: "clarifying_question",
+    data_request: "data_request",
+    analysis_complete: "analysis_complete",
+    chat_with_a_record_complete: "chat_with_a_record_complete"
+};
+/**
+ * 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;
+/**
+ * Defines the shape of the data that is expected by the Skip API Server when making a request
+ */
+class SkipAPIRequest {
+}
+exports.SkipAPIRequest = SkipAPIRequest;
+/**
+ * Defines the shape of the data that is returned by the Skip API Server
+ */
+class SkipAPIResponse {
+}
+exports.SkipAPIResponse = SkipAPIResponse;
+/**
+ * Special API request type that extends the base SkipAPIRequest to include script execution capabilities.
+ * Used when the requestPhase is 'run_existing_script' to execute pre-defined script text.
+ */
+class SkipAPIRunScriptRequest extends SkipAPIRequest {
+}
+exports.SkipAPIRunScriptRequest = SkipAPIRunScriptRequest;
+//# sourceMappingURL=api-types.js.map

package/dist/api-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-types.js","sourceRoot":"","sources":["../src/api-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG;;;AAUH;;;;;;;;;GASG;AACU,QAAA,gBAAgB,GAAG;IAC5B,eAAe,EAAE,iBAAiB;IAClC,yBAAyB,EAAE,2BAA2B;IACtD,uBAAuB,EAAE,yBAAyB;IAClD,sBAAsB,EAAE,wBAAwB;IAChD,mBAAmB,EAAE,qBAAqB;IAC1C,kBAAkB,EAAE,oBAAoB;CAClC,CAAC;AAGX;;;;;;;GAOG;AACU,QAAA,iBAAiB,GAAG;IAC7B,aAAa,EAAE,eAAe;IAC9B,mBAAmB,EAAE,qBAAqB;IAC1C,YAAY,EAAE,cAAc;IAC5B,iBAAiB,EAAE,mBAAmB;IACtC,2BAA2B,EAAE,6BAA6B;CACpD,CAAC;AAGX;;GAEG;AACH,MAAa,eAAe;CAgD3B;AAhDD,0CAgDC;AAED;;GAEG;AACH,MAAa,cAAc;CAgF1B;AAhFD,wCAgFC;AAED;;GAEG;AACH,MAAa,eAAe;CAkB3B;AAlBD,0CAkBC;AAED;;;GAGG;AACH,MAAa,uBAAwB,SAAQ,cAAc;CAK1D;AALD,0DAKC"}