@memberjunction/skip-types 2.43.0 → 2.45.0

package/dist/conversation-types.d.ts

@@ -0,0 +1,141 @@
+/**
+ * @fileoverview Conversation and messaging types for Skip API
+ *
+ * This file contains types related to conversations and messaging within the Skip API system.
+ * These types define the structure for:
+ *
+ * - Conversation data structures (SkipConversation)
+ * - Individual message format (SkipMessage)
+ * - Sub-process execution results (SkipSubProcessResponse)
+ *
+ * Conversations in Skip are the fundamental unit for tracking user interactions and AI responses.
+ * Each conversation contains an ordered array of messages that represent the back-and-forth
+ * dialogue between users and the Skip AI system. Messages can include user inputs, system
+ * responses, error information, feedback, and internal processing metadata.
+ *
+ * Sub-process responses are used when Skip executes code in a sandboxed environment and needs
+ * to communicate the results back to the main API server.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+import type { SkipAPIArtifact } from './artifact-types';
+/**
+ * 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";
+    /**
+     * For result types of data, this is the data that was returned from the sub-process to show in the table
+     */
+    tableData: any[] | null;
+    /**
+     * For result type of plot, this is the data that was returned from the sub-process to show in the plot
+     */
+    plotData: {
+        data: any[];
+        layout: any;
+    } | null;
+    /**
+     * If the request failed, this is the error message that was returned from the sub-process.
+     */
+    errorMessage: string | null;
+}
+/**
+ * Defines the shape of the conversations that can be passed back and forth with the Skip API Server - primarily used for the learning cycle process
+ */
+export declare class SkipConversation {
+    /**
+     * The unique identifier for the conversation
+     */
+    id: string;
+    /**
+     * The user-friendly name for the conversation
+     */
+    name: string;
+    /**
+     * The unique identifier for the user that the conversation is associated with
+     */
+    userId?: string;
+    /**
+     * The name of the user that the conversation is associated with
+     */
+    user?: string;
+    /**
+     * Optional, more detailed description of the conversation
+     */
+    description?: string;
+    /**
+     * Array of messages that make up the conversation in chronological order, showing the earliest messages first and the more recents messages last
+     */
+    messages: SkipMessage[];
+    /**
+     * Optional, this is an array of artifacts that are associated with the conversation. The AI Agent can request to add new artifacts during a response, this array is provided by the caller to ensure that the agent
+     * knows about existing artifacts/versions
+     */
+    artifacts?: SkipAPIArtifact[];
+    /**
+     * When the conversation was created
+     */
+    createdAt: Date;
+    /**
+     * The date the conversation header record was last updated - this is NOT the same as the most recent conversation detail, for that interrogate the conversation details
+     */
+    updatedAt: Date;
+}
+/**
+ * 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 {
+    /**
+     * The role of the message, either "user" or "system"
+     */
+    role: "user" | "system";
+    /**
+     * The content of the message, either the user's input or the system's response
+     */
+    content: string;
+    /**
+     * The conversation detail ID for the message, used to track the message
+     */
+    conversationDetailID: string;
+    /**
+     * If the message reflects an error message the information is provided here
+     */
+    error?: string;
+    /**
+     * hiddenToUser - this is true if a message is only for internal system puprose and not shown to a user
+     */
+    hiddenToUser?: boolean;
+    /**
+     * Rating scale between 1 and 10, 1 reflecting the lowest rating and 10 reflecting the highest rating from the user in terms of their satisfaction with the response
+     */
+    userRating?: number;
+    /**
+     * Optional, text feedback from the user reflecting their satisfaction with the response. Of course the subsequent messages can contain this, but this is an element that the UI will
+     * surface that allows a user to specifically provide feedback on each message.
+     */
+    userFeedback?: string;
+    /**
+     * Optional, this text is from Skip during the generation of a particular response and represents the step-wise reasoning Skip went through to get to a particular response. This information along with the preceding messages, User Rating and User Feedback can
+     * be very helpful during a learning cycle to build notes and other artifacts that can train Skip to learn more about the user/organization's preferences and the context of the conversation.
+     */
+    reflectionInsights?: string;
+    /**
+     * Optional, this text contains an AI generated summary of the prior messages in the conversation going back in time through the last such summary. This allows "compression" of a longer conversation to preserve space in a context window, improve performance and simplify
+     * inference.
+     */
+    summaryOfEarlierConveration?: string;
+    /**
+     * The date and time the message was created
+     */
+    createdAt?: Date;
+    /**
+     * The date and time the message was last updated
+     */
+    updatedAt?: Date;
+}
+//# sourceMappingURL=conversation-types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"conversation-types.d.ts","sourceRoot":"","sources":["../src/conversation-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD;;;;GAIG;AACH,qBAAa,sBAAsB;IAC/B,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC;IAC5B;;OAEG;IACH,SAAS,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IACxB;;OAEG;IACH,QAAQ,EAAE;QAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QAAC,MAAM,EAAE,GAAG,CAAA;KAAE,GAAG,IAAI,CAAC;IAC9C;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;GAEG;AACH,qBAAa,gBAAgB;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAC;IAExB;;;OAGG;IACH,SAAS,CAAC,EAAE,eAAe,EAAE,CAAC;IAE9B;;OAEG;IACH,SAAS,EAAE,IAAI,CAAC;IAChB;;OAEG;IACH,SAAS,EAAE,IAAI,CAAC;CACnB;AAED;;;GAGG;AACH,qBAAa,WAAW;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;CACpB"}

package/dist/conversation-types.js

@@ -0,0 +1,46 @@
+"use strict";
+/**
+ * @fileoverview Conversation and messaging types for Skip API
+ *
+ * This file contains types related to conversations and messaging within the Skip API system.
+ * These types define the structure for:
+ *
+ * - Conversation data structures (SkipConversation)
+ * - Individual message format (SkipMessage)
+ * - Sub-process execution results (SkipSubProcessResponse)
+ *
+ * Conversations in Skip are the fundamental unit for tracking user interactions and AI responses.
+ * Each conversation contains an ordered array of messages that represent the back-and-forth
+ * dialogue between users and the Skip AI system. Messages can include user inputs, system
+ * responses, error information, feedback, and internal processing metadata.
+ *
+ * Sub-process responses are used when Skip executes code in a sandboxed environment and needs
+ * to communicate the results back to the main API server.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SkipMessage = exports.SkipConversation = exports.SkipSubProcessResponse = void 0;
+/**
+ * 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.SkipSubProcessResponse = SkipSubProcessResponse;
+/**
+ * Defines the shape of the conversations that can be passed back and forth with the Skip API Server - primarily used for the learning cycle process
+ */
+class SkipConversation {
+}
+exports.SkipConversation = SkipConversation;
+/**
+ * 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;
+//# sourceMappingURL=conversation-types.js.map

package/dist/conversation-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conversation-types.js","sourceRoot":"","sources":["../src/conversation-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAIH;;;;GAIG;AACH,MAAa,sBAAsB;CAclC;AAdD,wDAcC;AAED;;GAEG;AACH,MAAa,gBAAgB;CA0C5B;AA1CD,4CA0CC;AAED;;;GAGG;AACH,MAAa,WAAW;CAuDvB;AAvDD,kCAuDC"}

package/dist/entity-metadata-types.d.ts

@@ -0,0 +1,125 @@
+/**
+ * @fileoverview Entity metadata and schema types for Skip API
+ *
+ * This file contains types that describe database entities, fields, relationships, and metadata
+ * structures used by the Skip API system. These types define the structure for:
+ *
+ * - Entity schema information (SkipEntityInfo)
+ * - Field definitions and metadata (SkipEntityFieldInfo, SkipEntityFieldValueInfo)
+ * - Entity relationships (SkipEntityRelationshipInfo)
+ * - Column descriptions for report data (SkipColumnInfo)
+ *
+ * These types are essential for communicating database schema information to Skip, allowing
+ * the AI to understand the structure, relationships, and constraints of the underlying data.
+ * This metadata enables Skip to generate appropriate SQL queries, understand data relationships,
+ * and provide meaningful analysis and reports.
+ *
+ * The entity metadata includes information about primary keys, foreign keys, data types,
+ * constraints, and relationships that Skip uses to navigate and query the database effectively.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+/**
+ * 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;
+}
+/**
+ * Enumerates the possible values for a given field
+ */
+export declare class SkipEntityFieldValueInfo {
+    /**
+     * Actual value for the possible value for the field
+     */
+    value: string;
+    /**
+     * Optional, the display value for the field value
+     */
+    displayValue?: string;
+}
+/**
+ * Comprehensive metadata about individual entity fields, including data types, constraints,
+ * relationships, and UI display preferences. This information helps Skip understand how
+ * to work with each field in queries and analysis.
+ */
+export declare class SkipEntityFieldInfo {
+    entityID: string;
+    sequence: number;
+    name: string;
+    displayName?: string;
+    description?: string;
+    isPrimaryKey: boolean;
+    isUnique: boolean;
+    category?: string;
+    type: string;
+    length: number;
+    precision: number;
+    scale: number;
+    sqlFullType: string;
+    allowsNull: boolean;
+    defaultValue: string;
+    autoIncrement: boolean;
+    valueListType?: string;
+    extendedType?: string;
+    defaultInView: boolean;
+    defaultColumnWidth: number;
+    isVirtual: boolean;
+    isNameField: boolean;
+    relatedEntityID?: string;
+    relatedEntityFieldName?: string;
+    relatedEntity?: string;
+    relatedEntitySchemaName?: string;
+    relatedEntityBaseView?: string;
+    possibleValues?: SkipEntityFieldValueInfo[];
+}
+/**
+ * Defines relationships between entities, including foreign key relationships and
+ * many-to-many relationships through junction tables. This information allows Skip
+ * to understand how entities are connected and generate appropriate JOIN queries.
+ */
+export declare class SkipEntityRelationshipInfo {
+    entityID: string;
+    relatedEntityID: string;
+    type: string;
+    entityKeyField: string;
+    relatedEntityJoinField: string;
+    joinView: string;
+    joinEntityJoinField: string;
+    joinEntityInverseJoinField: string;
+    entity: string;
+    entityBaseView: string;
+    relatedEntity: string;
+    relatedEntityBaseView: string;
+}
+/**
+ * Complete metadata about a database entity including its fields, relationships,
+ * and optionally sample data. This is the primary structure used to communicate
+ * entity schema information to Skip for analysis and query generation.
+ */
+export declare class SkipEntityInfo {
+    id: string;
+    name: string;
+    description?: string;
+    schemaName: string;
+    baseView: string;
+    fields: SkipEntityFieldInfo[];
+    relatedEntities: SkipEntityRelationshipInfo[];
+    /**
+     * If rows packed is set to anything other than none, the data is provided in the rows property.
+     */
+    rowsPacked?: 'None' | 'Sample' | 'All';
+    /**
+     * If rowsPacked === 'Sample', this additional property is used to indicate the method used to sample the rows
+     */
+    rowsSampleMethod?: 'random' | 'top n' | 'bottom n';
+    /**
+     * Optional, the metadata can include an array of rows that can be used to provide context to Skip for the data that is being passed in.
+     */
+    rows?: any[];
+}
+//# sourceMappingURL=entity-metadata-types.d.ts.map

package/dist/entity-metadata-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-metadata-types.d.ts","sourceRoot":"","sources":["../src/entity-metadata-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH;;GAEG;AACH,qBAAa,cAAc;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;IACzD,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,qBAAa,wBAAwB;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,qBAAa,mBAAmB;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,OAAO,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,cAAc,CAAC,EAAE,wBAAwB,EAAE,CAAC;CAC/C;AAED;;;;GAIG;AACH,qBAAa,0BAA0B;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,0BAA0B,EAAE,MAAM,CAAC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,qBAAqB,EAAE,MAAM,CAAC;CACjC;AAED;;;;GAIG;AACH,qBAAa,cAAc;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAG,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAG,MAAM,CAAC;IACpB,QAAQ,EAAG,MAAM,CAAC;IAClB,MAAM,EAAE,mBAAmB,EAAE,CAAK;IAClC,eAAe,EAAE,0BAA0B,EAAE,CAAM;IAEnD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAU;IAChD;;OAEG;IACH,gBAAgB,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAY;IAC9D;;OAEG;IACH,IAAI,CAAC,EAAE,GAAG,EAAE,CAAM;CACrB"}

package/dist/entity-metadata-types.js

@@ -0,0 +1,78 @@
+"use strict";
+/**
+ * @fileoverview Entity metadata and schema types for Skip API
+ *
+ * This file contains types that describe database entities, fields, relationships, and metadata
+ * structures used by the Skip API system. These types define the structure for:
+ *
+ * - Entity schema information (SkipEntityInfo)
+ * - Field definitions and metadata (SkipEntityFieldInfo, SkipEntityFieldValueInfo)
+ * - Entity relationships (SkipEntityRelationshipInfo)
+ * - Column descriptions for report data (SkipColumnInfo)
+ *
+ * These types are essential for communicating database schema information to Skip, allowing
+ * the AI to understand the structure, relationships, and constraints of the underlying data.
+ * This metadata enables Skip to generate appropriate SQL queries, understand data relationships,
+ * and provide meaningful analysis and reports.
+ *
+ * The entity metadata includes information about primary keys, foreign keys, data types,
+ * constraints, and relationships that Skip uses to navigate and query the database effectively.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SkipEntityInfo = exports.SkipEntityRelationshipInfo = exports.SkipEntityFieldInfo = exports.SkipEntityFieldValueInfo = exports.SkipColumnInfo = void 0;
+/**
+ * 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;
+/**
+ * Enumerates the possible values for a given field
+ */
+class SkipEntityFieldValueInfo {
+}
+exports.SkipEntityFieldValueInfo = SkipEntityFieldValueInfo;
+/**
+ * Comprehensive metadata about individual entity fields, including data types, constraints,
+ * relationships, and UI display preferences. This information helps Skip understand how
+ * to work with each field in queries and analysis.
+ */
+class SkipEntityFieldInfo {
+}
+exports.SkipEntityFieldInfo = SkipEntityFieldInfo;
+/**
+ * Defines relationships between entities, including foreign key relationships and
+ * many-to-many relationships through junction tables. This information allows Skip
+ * to understand how entities are connected and generate appropriate JOIN queries.
+ */
+class SkipEntityRelationshipInfo {
+}
+exports.SkipEntityRelationshipInfo = SkipEntityRelationshipInfo;
+/**
+ * Complete metadata about a database entity including its fields, relationships,
+ * and optionally sample data. This is the primary structure used to communicate
+ * entity schema information to Skip for analysis and query generation.
+ */
+class SkipEntityInfo {
+    constructor() {
+        this.fields = [];
+        this.relatedEntities = [];
+        /**
+         * If rows packed is set to anything other than none, the data is provided in the rows property.
+         */
+        this.rowsPacked = 'None';
+        /**
+         * If rowsPacked === 'Sample', this additional property is used to indicate the method used to sample the rows
+         */
+        this.rowsSampleMethod = 'random';
+        /**
+         * Optional, the metadata can include an array of rows that can be used to provide context to Skip for the data that is being passed in.
+         */
+        this.rows = [];
+    }
+}
+exports.SkipEntityInfo = SkipEntityInfo;
+//# sourceMappingURL=entity-metadata-types.js.map

package/dist/entity-metadata-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-metadata-types.js","sourceRoot":"","sources":["../src/entity-metadata-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;;AAEH;;GAEG;AACH,MAAa,cAAc;CAK1B;AALD,wCAKC;AAED;;GAEG;AACH,MAAa,wBAAwB;CASpC;AATD,4DASC;AAED;;;;GAIG;AACH,MAAa,mBAAmB;CA8B/B;AA9BD,kDA8BC;AAED;;;;GAIG;AACH,MAAa,0BAA0B;CAatC;AAbD,gEAaC;AAED;;;;GAIG;AACH,MAAa,cAAc;IAA3B;QAMI,WAAM,GAAyB,EAAE,CAAC;QAClC,oBAAe,GAAiC,EAAE,CAAC;QAEnD;;WAEG;QACH,eAAU,GAA+B,MAAM,CAAC;QAChD;;WAEG;QACH,qBAAgB,GAAqC,QAAQ,CAAC;QAC9D;;WAEG;QACH,SAAI,GAAW,EAAE,CAAC;IACtB,CAAC;CAAA;AArBD,wCAqBC"}

package/dist/index.d.ts

@@ -1,2 +1,12 @@
-export * from './types';
+export * from './api-types';
+export * from './conversation-types';
+export * from './response-types';
+export * from './entity-metadata-types';
+export * from './query-types';
+export * from './agent-types';
+export * from './artifact-types';
+export * from './auth-types';
+export * from './component-types';
+export * from './shared';
+export * from './util';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AAEzB,cAAc,QAAQ,CAAC"}

package/dist/index.js

@@ -14,5 +14,16 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
+// Re-export all types from organized modules
+__exportStar(require("./api-types"), exports);
+__exportStar(require("./conversation-types"), exports);
+__exportStar(require("./response-types"), exports);
+__exportStar(require("./entity-metadata-types"), exports);
+__exportStar(require("./query-types"), exports);
+__exportStar(require("./agent-types"), exports);
+__exportStar(require("./artifact-types"), exports);
+__exportStar(require("./auth-types"), exports);
+__exportStar(require("./component-types"), exports);
+__exportStar(require("./shared"), exports);
+__exportStar(require("./util"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,8CAA4B;AAC5B,uDAAqC;AACrC,mDAAiC;AACjC,0DAAwC;AACxC,gDAA8B;AAC9B,gDAA8B;AAC9B,mDAAiC;AACjC,+CAA6B;AAC7B,oDAAkC;AAClC,2CAAyB;AAEzB,yCAAuB"}

package/dist/query-types.d.ts

@@ -0,0 +1,107 @@
+/**
+ * @fileoverview Query and data request types for Skip API
+ *
+ * This file contains types related to database queries, stored queries, and data requests
+ * within the Skip API system. These types define the structure for:
+ *
+ * - Stored query metadata (SkipQueryInfo, SkipQueryFieldInfo)
+ * - Data request specifications (SkipDataRequest, SkipDataRequestType)
+ * - Learning cycle query change tracking (SkipLearningCycleQueryChange)
+ *
+ * These types enable Skip to understand and work with pre-defined queries stored in the
+ * MemberJunction metadata system, as well as handle dynamic data requests that Skip
+ * generates during analysis. The query metadata includes information about query
+ * parameters, field definitions, quality rankings, and approval status.
+ *
+ * Data requests allow Skip to ask for additional data beyond what was initially provided,
+ * either through custom SQL statements or by referencing stored queries. This capability
+ * enables Skip to iteratively refine its analysis by gathering the exact data it needs.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+/**
+ * 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, as defined in the `SkipDataRequestType` type
+     */
+    type: SkipDataRequestType;
+    /**
+     * The text of the request - either a fully executable SQL statement or the name of a stored query
+     */
+    text: string;
+    /**
+     * A description of the request, why it was requested, and what it is expected to provide
+     */
+    description?: string;
+}
+/**
+ * Metadata about individual fields within a stored query, including their data types,
+ * source entity mappings, and computed field information. This helps Skip understand
+ * the structure and meaning of query results.
+ */
+export declare class SkipQueryFieldInfo {
+    name: string;
+    queryID: string;
+    description: string;
+    sequence: number;
+    /**
+     * The base type, not including parameters, in SQL. For example this field would be nvarchar or decimal, and wouldn't include type parameters. The SQLFullType field provides that information.
+     */
+    sqlBaseType: string;
+    /**
+     * The full SQL type for the field, for example datetime or nvarchar(10) etc.
+     */
+    sqlFullType: string;
+    sourceEntityID: string;
+    sourceFieldName: string;
+    isComputed: boolean;
+    computationDescription: string;
+    isSummary: boolean;
+    summaryDescription: string;
+    createdAt: Date;
+    updatedAt: Date;
+    sourceEntity: string;
+}
+/**
+ * Complete metadata about a stored query, including its SQL, approval status, quality ranking,
+ * and field definitions. This information allows Skip to understand and utilize pre-built
+ * queries for analysis and reporting.
+ */
+export declare class SkipQueryInfo {
+    id: string;
+    name: string;
+    description: string;
+    categoryID: string;
+    sql: string;
+    originalSQL: string;
+    feedback: string;
+    status: 'Pending' | 'In-Review' | 'Approved' | 'Rejected' | 'Obsolete';
+    qualityRank: number;
+    createdAt: Date;
+    updatedAt: Date;
+    category: string;
+    fields: SkipQueryFieldInfo[];
+}
+/**
+ * Represents a change to a query during the learning cycle process, allowing Skip
+ * to add new queries, update existing ones, or mark queries for deletion based on
+ * its analysis of conversation patterns and user needs.
+ */
+export declare class SkipLearningCycleQueryChange {
+    query: SkipQueryInfo;
+    changeType: 'add' | 'update' | 'delete';
+}
+//# sourceMappingURL=query-types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"query-types.d.ts","sourceRoot":"","sources":["../src/query-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;CAGtB,CAAC;AACX,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAE/F;;GAEG;AACH,qBAAa,eAAe;IACxB;;OAEG;IACH,IAAI,EAAG,mBAAmB,CAAC;IAC3B;;OAEG;IACH,IAAI,EAAG,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,qBAAa,kBAAkB;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,OAAO,CAAC;IACpB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,SAAS,EAAE,OAAO,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,qBAAa,aAAa;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,CAAC;IACvE,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,kBAAkB,EAAE,CAAC;CAChC;AAED;;;;GAIG;AACH,qBAAa,4BAA4B;IACrC,KAAK,EAAE,aAAa,CAAC;IACrB,UAAU,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;CAC3C"}

package/dist/query-types.js

@@ -0,0 +1,65 @@
+"use strict";
+/**
+ * @fileoverview Query and data request types for Skip API
+ *
+ * This file contains types related to database queries, stored queries, and data requests
+ * within the Skip API system. These types define the structure for:
+ *
+ * - Stored query metadata (SkipQueryInfo, SkipQueryFieldInfo)
+ * - Data request specifications (SkipDataRequest, SkipDataRequestType)
+ * - Learning cycle query change tracking (SkipLearningCycleQueryChange)
+ *
+ * These types enable Skip to understand and work with pre-defined queries stored in the
+ * MemberJunction metadata system, as well as handle dynamic data requests that Skip
+ * generates during analysis. The query metadata includes information about query
+ * parameters, field definitions, quality rankings, and approval status.
+ *
+ * Data requests allow Skip to ask for additional data beyond what was initially provided,
+ * either through custom SQL statements or by referencing stored queries. This capability
+ * enables Skip to iteratively refine its analysis by gathering the exact data it needs.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SkipLearningCycleQueryChange = exports.SkipQueryInfo = exports.SkipQueryFieldInfo = exports.SkipDataRequest = exports.SkipDataRequestType = void 0;
+/**
+ * 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
+ */
+class SkipDataRequest {
+}
+exports.SkipDataRequest = SkipDataRequest;
+/**
+ * Metadata about individual fields within a stored query, including their data types,
+ * source entity mappings, and computed field information. This helps Skip understand
+ * the structure and meaning of query results.
+ */
+class SkipQueryFieldInfo {
+}
+exports.SkipQueryFieldInfo = SkipQueryFieldInfo;
+/**
+ * Complete metadata about a stored query, including its SQL, approval status, quality ranking,
+ * and field definitions. This information allows Skip to understand and utilize pre-built
+ * queries for analysis and reporting.
+ */
+class SkipQueryInfo {
+}
+exports.SkipQueryInfo = SkipQueryInfo;
+/**
+ * Represents a change to a query during the learning cycle process, allowing Skip
+ * to add new queries, update existing ones, or mark queries for deletion based on
+ * its analysis of conversation patterns and user needs.
+ */
+class SkipLearningCycleQueryChange {
+}
+exports.SkipLearningCycleQueryChange = SkipLearningCycleQueryChange;
+//# sourceMappingURL=query-types.js.map

package/dist/query-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-types.js","sourceRoot":"","sources":["../src/query-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;;AAEH;;;;GAIG;AACU,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,KAAK;IACV,YAAY,EAAE,cAAc;CACtB,CAAC;AAGX;;GAEG;AACH,MAAa,eAAe;CAa3B;AAbD,0CAaC;AAED;;;;GAIG;AACH,MAAa,kBAAkB;CAsB9B;AAtBD,gDAsBC;AAED;;;;GAIG;AACH,MAAa,aAAa;CAczB;AAdD,sCAcC;AAED;;;;GAIG;AACH,MAAa,4BAA4B;CAGxC;AAHD,oEAGC"}