@memberjunction/skip-types 2.44.0 → 2.46.0

package/dist/response-types.d.ts

@@ -0,0 +1,156 @@
+/**
+ * @fileoverview Specific API response types for Skip API
+ *
+ * This file contains specialized response types that extend the base SkipAPIResponse for different
+ * response phases and scenarios. These types define the structure for:
+ *
+ * - Analysis completion responses (SkipAPIAnalysisCompleteResponse)
+ * - Clarifying question responses (SkipAPIClarifyingQuestionResponse)
+ * - Data request responses (SkipAPIDataRequestResponse)
+ * - Chat with record responses (SkipAPIChatWithRecordResponse)
+ * - Drill-down functionality for components (SkipAPIAnalysisDrillDown, SkipAPIAnalysisDrillDownFilter)
+ *
+ * Each response type corresponds to a specific responsePhase value and contains additional
+ * properties relevant to that particular type of response. These specialized response types
+ * allow clients to access type-safe, context-specific data based on the response phase.
+ *
+ * The analysis complete response is particularly comprehensive, containing component data,
+ * explanations, column metadata, drill-down information, and component options.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+import { SkipAPIResponse } from './api-types';
+import type { SkipSubProcessResponse } from './conversation-types';
+import type { SkipColumnInfo } from './entity-metadata-types';
+import type { SkipDataRequest } from './query-types';
+import type { SkipAPIArtifactRequest } from './artifact-types';
+import { SimpleDataContext } from './shared';
+import { SkipComponentOption } from './component-types';
+/**
+ * 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 {
+    componentFieldName: string;
+    viewFieldName: string;
+}
+/**
+ * Defines the filtering information necessary for a component UI to enable behavior to drill down when a user clicks on a portion of a component 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 component
+     */
+    viewName: string;
+    /**
+     * If the data context that was provided to Skip for generating a component had filtered data related to the drill down view noted in viewName property, then this
+     * baseFilter value will be populated with a SQL filter that can be added to a WHERE clause with an AND statement to ensure that the filtering is inclusive of the
+     * data context's in-built filters.
+     */
+    baseFilter: 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 {
+    /**
+     * The data context that was passed in with the request, this is used to know the source data at the time the process was executed and for simple persistence.
+     */
+    dataContext: SimpleDataContext;
+    /**
+     * The type of component generated, data is a simple table, plot is a chart and html is a custom HTML component
+     * For data/plot types, the results will be server-generated and available in the executionResults property
+     * For html type, the executionResults will be null because the server generates an HTML component that is intended to run on the client.
+     */
+    resultType: "data" | "plot" | "html" | null;
+    /**
+     * The results of the execution of the sub-process to run the server-side script
+     */
+    executionResults?: SkipSubProcessResponse | null;
+    /**
+     * A user-friendly explanation of what the component does
+     */
+    userExplanation?: string;
+    /**
+     * A more detailed technical explanation of what the component does and how it works
+     */
+    techExplanation?: string;
+    /**
+     * Describes each column in the component'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 component
+     */
+    suggestedQuestions?: string[] | null;
+    /**
+     * Legacy property that is no longer used, but is kept for backwards compatibility
+     * @deprecated This property is no longer used and will be removed in a future version. Use the `title` property instead.
+     */
+    reportTitle?: string | null;
+    /**
+     * The title of the component
+     */
+    title?: string | null;
+    /**
+     * An analysis of the component, the data and the formatted component output.
+     */
+    analysis?: string | null;
+    /**
+     * Information that will support a drill-down experience in the component UI
+     */
+    drillDown?: SkipAPIAnalysisDrillDown | null;
+    /**
+     * The script text that was used to generated the component and can be saved to be run again later
+     */
+    scriptText?: string | null;
+    /**
+     * When provided, this array of data requests indicate to the caller of the Skip API that Skip was able to retrieve, on his own, additional data
+     * BEYOND what was provided in the SkipAPIRequest object. The caller of the Skip API should update its internal representation of its data context
+     * to include these new data items so that they will be run and provided to Skip for future iterations/requests and for re-running components as well.
+     */
+    newDataItems?: SkipDataRequest[];
+    /**
+     * Contains a list of all the possible components that were generated (1 or more) for the given request.
+     */
+    componentOptions?: SkipComponentOption[];
+    /**
+     * If the AI Agent decides it would be best to display the result in an artifact, this information can be used by the calling application to properly
+     * associate this specific response with the artifact that is being created. This is typically used for output that is likely to have iterations where
+     * artifacts are a clean way of managing a UI in the calling application where you can show multiple versions/etc.
+     */
+    artifactRequest?: SkipAPIArtifactRequest;
+}
+/**
+ * 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 answers that the AI model suggests might be good responses to the clarifying question
+     */
+    suggestedAnswers: string[];
+}
+/**
+ * Defines the shape of the data that is returned by the Skip API Server when the responsePhase is 'data_request'
+ */
+export declare class SkipAPIDataRequestResponse extends SkipAPIResponse {
+    dataRequest: SkipDataRequest[];
+}
+/**
+ * Defines the shape of the data that is returned by the Skip API Server when the responsePhase is 'chat_with_a_record_complete'
+ */
+export declare class SkipAPIChatWithRecordResponse extends SkipAPIResponse {
+    /**
+     * The response from the AI model regarding the user request
+     */
+    response: string;
+}
+//# sourceMappingURL=response-types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"response-types.d.ts","sourceRoot":"","sources":["../src/response-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AACnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAExD;;GAEG;AACH,qBAAa,8BAA8B;IACvC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,aAAa,EAAE,MAAM,CAAA;CACxB;AAED;;GAEG;AACH,qBAAa,wBAAwB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,8BAA8B,EAAE,CAAC;CAC7C;AAED;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,eAAe;IAChE;;OAEG;IACH,WAAW,EAAE,iBAAiB,CAAC;IAC/B;;;;OAIG;IACH,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAC5C;;OAEG;IACH,gBAAgB,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;IACjD;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,cAAc,EAAE,CAAC;IACpC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAC5C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;;;OAIG;IACH,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;IAEjC;;OAEG;IACH,gBAAgB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAEzC;;;;OAIG;IACH,eAAe,CAAC,EAAE,sBAAsB,CAAC;CAC5C;AAED;;GAEG;AACH,qBAAa,iCAAkC,SAAQ,eAAe;IAClE;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,eAAe;IAC3D,WAAW,EAAE,eAAe,EAAE,CAAC;CAClC;AAED;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,eAAe;IAC9D;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;CACnB"}

package/dist/response-types.js

@@ -0,0 +1,63 @@
+"use strict";
+/**
+ * @fileoverview Specific API response types for Skip API
+ *
+ * This file contains specialized response types that extend the base SkipAPIResponse for different
+ * response phases and scenarios. These types define the structure for:
+ *
+ * - Analysis completion responses (SkipAPIAnalysisCompleteResponse)
+ * - Clarifying question responses (SkipAPIClarifyingQuestionResponse)
+ * - Data request responses (SkipAPIDataRequestResponse)
+ * - Chat with record responses (SkipAPIChatWithRecordResponse)
+ * - Drill-down functionality for components (SkipAPIAnalysisDrillDown, SkipAPIAnalysisDrillDownFilter)
+ *
+ * Each response type corresponds to a specific responsePhase value and contains additional
+ * properties relevant to that particular type of response. These specialized response types
+ * allow clients to access type-safe, context-specific data based on the response phase.
+ *
+ * The analysis complete response is particularly comprehensive, containing component data,
+ * explanations, column metadata, drill-down information, and component options.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SkipAPIChatWithRecordResponse = exports.SkipAPIDataRequestResponse = exports.SkipAPIClarifyingQuestionResponse = exports.SkipAPIAnalysisCompleteResponse = exports.SkipAPIAnalysisDrillDown = exports.SkipAPIAnalysisDrillDownFilter = void 0;
+const api_types_1 = require("./api-types");
+/**
+ * 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 component UI to enable behavior to drill down when a user clicks on a portion of a component 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'
+ */
+class SkipAPIAnalysisCompleteResponse extends api_types_1.SkipAPIResponse {
+}
+exports.SkipAPIAnalysisCompleteResponse = SkipAPIAnalysisCompleteResponse;
+/**
+ * Defines the shape of the data that is returned by the Skip API Server when the responsePhase is 'clarifying_question'
+ */
+class SkipAPIClarifyingQuestionResponse extends api_types_1.SkipAPIResponse {
+}
+exports.SkipAPIClarifyingQuestionResponse = SkipAPIClarifyingQuestionResponse;
+/**
+ * Defines the shape of the data that is returned by the Skip API Server when the responsePhase is 'data_request'
+ */
+class SkipAPIDataRequestResponse extends api_types_1.SkipAPIResponse {
+}
+exports.SkipAPIDataRequestResponse = SkipAPIDataRequestResponse;
+/**
+ * Defines the shape of the data that is returned by the Skip API Server when the responsePhase is 'chat_with_a_record_complete'
+ */
+class SkipAPIChatWithRecordResponse extends api_types_1.SkipAPIResponse {
+}
+exports.SkipAPIChatWithRecordResponse = SkipAPIChatWithRecordResponse;
+//# sourceMappingURL=response-types.js.map

package/dist/response-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-types.js","sourceRoot":"","sources":["../src/response-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;;AAEH,2CAA8C;AAQ9C;;GAEG;AACH,MAAa,8BAA8B;CAG1C;AAHD,wEAGC;AAED;;GAEG;AACH,MAAa,wBAAwB;CAepC;AAfD,4DAeC;AAED;;GAEG;AACH,MAAa,+BAAgC,SAAQ,2BAAe;CAwEnE;AAxED,0EAwEC;AAED;;GAEG;AACH,MAAa,iCAAkC,SAAQ,2BAAe;CASrE;AATD,8EASC;AAED;;GAEG;AACH,MAAa,0BAA2B,SAAQ,2BAAe;CAE9D;AAFD,gEAEC;AAED;;GAEG;AACH,MAAa,6BAA8B,SAAQ,2BAAe;CAKjE;AALD,sEAKC"}

package/dist/shared.d.ts

@@ -0,0 +1,44 @@
+import { RunQueryParams, RunQueryResult, RunViewParams, RunViewResult } from "@memberjunction/core";
+import { SkipEntityInfo } from "./entity-metadata-types";
+/**
+ * This is a simple data context object that is passed into the SkipComponentInitFunction, it contains a property for each of the data context items and typically are named
+ * data_item_1, data_item_2, etc. The data context is a simple JavaScript object that contains properties that are in turn data objects which are typically arrays of things, but can be anything.
+ */
+export type SimpleDataContext = {
+    [key: string]: any;
+};
+/**
+ * Simple version of the @interface Metadata MemberJunction object that is passed to the Skip component.
+ */
+export interface SimpleMetadata {
+    entities: SkipEntityInfo[];
+}
+/**
+* Simple interface for running views in MemberJunction that can be used by components generated by Skip
+ */
+export interface SimpleRunView {
+    /**
+     * Run a single view and return the results. The view is run dynamically against the MemberJunction host environment.
+     * @param params
+     * @returns
+     */
+    runView: (params: RunViewParams) => Promise<RunViewResult>;
+    /**
+     * Runs multiple views and returns the results. This is useful for running multiple views in parallel and returning the results in a single call.
+     * @param params
+     * @returns
+     */
+    runViews: (params: RunViewParams[]) => Promise<RunViewResult[]>;
+}
+/**
+ * Simple interface for running predefined queries in MemberJunction that can be used by components generated by Skip
+ */
+export interface SimpleRunQuery {
+    /**
+     * Run a single predefined query and return the results. The query is run dynamically against the MemberJunction host environment.
+     * @param params
+     * @returns
+     */
+    runQuery: (params: RunQueryParams) => Promise<RunQueryResult>;
+}
+//# sourceMappingURL=shared.d.ts.map

package/dist/shared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/shared.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACpG,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,QAAQ,EAAE,cAAc,EAAE,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,OAAO,CAAC,aAAa,CAAC,CAAA;IAC1D;;;;OAIG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,KAAK,OAAO,CAAC,aAAa,EAAE,CAAC,CAAA;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;OAIG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,cAAc,KAAK,OAAO,CAAC,cAAc,CAAC,CAAA;CAChE"}

package/dist/shared.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shared.js.map

package/dist/shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.js","sourceRoot":"","sources":["../src/shared.ts"],"names":[],"mappings":""}