@memberjunction/skip-types 3.4.0 → 4.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/agent-types.d.ts +4 -4
- package/dist/agent-types.js +7 -17
- package/dist/agent-types.js.map +1 -1
- package/dist/api-types.d.ts +6 -6
- package/dist/api-types.js +6 -13
- package/dist/api-types.js.map +1 -1
- package/dist/artifact-types.js +1 -2
- package/dist/artifact-types.js.map +1 -1
- package/dist/auth-types.js +1 -5
- package/dist/auth-types.js.map +1 -1
- package/dist/conversation-types.d.ts +1 -1
- package/dist/conversation-types.js +3 -9
- package/dist/conversation-types.js.map +1 -1
- package/dist/entity-metadata-types.js +1 -2
- package/dist/index.d.ts +9 -9
- package/dist/index.js +9 -25
- package/dist/index.js.map +1 -1
- package/dist/query-types.js +7 -16
- package/dist/query-types.js.map +1 -1
- package/dist/response-types.d.ts +5 -5
- package/dist/response-types.js +7 -16
- package/dist/response-types.js.map +1 -1
- package/dist/util.d.ts +1 -1
- package/dist/util.js +18 -36
- package/dist/util.js.map +1 -1
- package/package.json +8 -7
- package/readme.md +22 -1
package/dist/agent-types.d.ts
CHANGED
|
@@ -20,10 +20,10 @@
|
|
|
20
20
|
* Notes provide a way for Skip to store and retrieve organizational knowledge, user
|
|
21
21
|
* preferences, and contextual information that improves future interactions.
|
|
22
22
|
*/
|
|
23
|
-
import type { SkipConversation } from './conversation-types';
|
|
24
|
-
import type { SkipEntityInfo } from './entity-metadata-types';
|
|
25
|
-
import type { SkipQueryInfo, SkipLearningCycleQueryChange } from './query-types';
|
|
26
|
-
import type { SkipAPIRequestAPIKey } from './auth-types';
|
|
23
|
+
import type { SkipConversation } from './conversation-types.js';
|
|
24
|
+
import type { SkipEntityInfo } from './entity-metadata-types.js';
|
|
25
|
+
import type { SkipQueryInfo, SkipLearningCycleQueryChange } from './query-types.js';
|
|
26
|
+
import type { SkipAPIRequestAPIKey } from './auth-types.js';
|
|
27
27
|
/**
|
|
28
28
|
* Type that defines a possible note type from the source system that invoked Skip
|
|
29
29
|
*/
|
package/dist/agent-types.js
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/**
|
|
3
2
|
* @fileoverview AI Agent and learning cycle types for Skip API
|
|
4
3
|
*
|
|
@@ -21,53 +20,44 @@
|
|
|
21
20
|
* Notes provide a way for Skip to store and retrieve organizational knowledge, user
|
|
22
21
|
* preferences, and contextual information that improves future interactions.
|
|
23
22
|
*/
|
|
24
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.SkipAPILearningCycleResponse = exports.SkipAPILearningCycleRequest = exports.SkipLearningCycleRequestChange = exports.SkipLearningCycleNoteChange = exports.SkipAPIAgentRequest = exports.SkipAPIAgentNote = exports.SkipAPIAgentNoteType = void 0;
|
|
26
23
|
/**
|
|
27
24
|
* Type that defines a possible note type from the source system that invoked Skip
|
|
28
25
|
*/
|
|
29
|
-
class SkipAPIAgentNoteType {
|
|
26
|
+
export class SkipAPIAgentNoteType {
|
|
30
27
|
}
|
|
31
|
-
exports.SkipAPIAgentNoteType = SkipAPIAgentNoteType;
|
|
32
28
|
/**
|
|
33
29
|
* Defines the shape of an individual Agent note that is stored in MJ that can be passed to Skip for additional context.
|
|
34
30
|
*/
|
|
35
|
-
class SkipAPIAgentNote {
|
|
31
|
+
export class SkipAPIAgentNote {
|
|
36
32
|
}
|
|
37
|
-
exports.SkipAPIAgentNote = SkipAPIAgentNote;
|
|
38
33
|
/**
|
|
39
34
|
* Whenever an agent is interested in getting human-in-the-loop style feedback/approval, this type is used
|
|
40
35
|
*/
|
|
41
|
-
class SkipAPIAgentRequest {
|
|
36
|
+
export class SkipAPIAgentRequest {
|
|
42
37
|
}
|
|
43
|
-
exports.SkipAPIAgentRequest = SkipAPIAgentRequest;
|
|
44
38
|
/**
|
|
45
39
|
* Represents a change to agent notes during the learning cycle process, allowing Skip
|
|
46
40
|
* to add new notes, update existing ones, or mark notes for deletion based on
|
|
47
41
|
* its analysis of conversation patterns and organizational learning.
|
|
48
42
|
*/
|
|
49
|
-
class SkipLearningCycleNoteChange {
|
|
43
|
+
export class SkipLearningCycleNoteChange {
|
|
50
44
|
}
|
|
51
|
-
exports.SkipLearningCycleNoteChange = SkipLearningCycleNoteChange;
|
|
52
45
|
/**
|
|
53
46
|
* Represents a change to agent requests during the learning cycle process, allowing Skip
|
|
54
47
|
* to add new requests, update existing ones, or mark requests for deletion based on
|
|
55
48
|
* its analysis of conversation patterns and user feedback.
|
|
56
49
|
*/
|
|
57
|
-
class SkipLearningCycleRequestChange {
|
|
50
|
+
export class SkipLearningCycleRequestChange {
|
|
58
51
|
}
|
|
59
|
-
exports.SkipLearningCycleRequestChange = SkipLearningCycleRequestChange;
|
|
60
52
|
/**
|
|
61
53
|
* 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
|
|
62
54
|
*/
|
|
63
|
-
class SkipAPILearningCycleRequest {
|
|
55
|
+
export class SkipAPILearningCycleRequest {
|
|
64
56
|
}
|
|
65
|
-
exports.SkipAPILearningCycleRequest = SkipAPILearningCycleRequest;
|
|
66
57
|
/**
|
|
67
58
|
* 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
|
|
68
59
|
* to then be passed into future Skip API requests for analysis/etc.
|
|
69
60
|
*/
|
|
70
|
-
class SkipAPILearningCycleResponse {
|
|
61
|
+
export class SkipAPILearningCycleResponse {
|
|
71
62
|
}
|
|
72
|
-
exports.SkipAPILearningCycleResponse = SkipAPILearningCycleResponse;
|
|
73
63
|
//# sourceMappingURL=agent-types.js.map
|
package/dist/agent-types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"agent-types.js","sourceRoot":"","sources":["../src/agent-types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"agent-types.js","sourceRoot":"","sources":["../src/agent-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAOH;;GAEG;AACH,MAAM,OAAO,oBAAoB;CAIhC;AAED;;GAEG;AACH,MAAM,OAAO,gBAAgB;CAqC5B;AAED;;GAEG;AACH,MAAM,OAAO,mBAAmB;CA8D/B;AAED;;;;GAIG;AACH,MAAM,OAAO,2BAA2B;CAGvC;AAED;;;;GAIG;AACH,MAAM,OAAO,8BAA8B;CAG1C;AAED;;GAEG;AACH,MAAM,OAAO,2BAA2B;CA6DvC;AAED;;;GAGG;AACH,MAAM,OAAO,4BAA4B;CAmCxC"}
|
package/dist/api-types.d.ts
CHANGED
|
@@ -12,12 +12,12 @@
|
|
|
12
12
|
* across all Skip API interactions regardless of the specific functionality being invoked.
|
|
13
13
|
*/
|
|
14
14
|
import { DataContext } from '@memberjunction/data-context';
|
|
15
|
-
import type { SkipMessage } from './conversation-types';
|
|
16
|
-
import type { SkipEntityInfo } from './entity-metadata-types';
|
|
17
|
-
import type { SkipQueryInfo } from './query-types';
|
|
18
|
-
import type { SkipAPIRequestAPIKey } from './auth-types';
|
|
19
|
-
import type { SkipAPIArtifact } from './artifact-types';
|
|
20
|
-
import type { SkipAPIAgentNote, SkipAPIAgentNoteType } from './agent-types';
|
|
15
|
+
import type { SkipMessage } from './conversation-types.js';
|
|
16
|
+
import type { SkipEntityInfo } from './entity-metadata-types.js';
|
|
17
|
+
import type { SkipQueryInfo } from './query-types.js';
|
|
18
|
+
import type { SkipAPIRequestAPIKey } from './auth-types.js';
|
|
19
|
+
import type { SkipAPIArtifact } from './artifact-types.js';
|
|
20
|
+
import type { SkipAPIAgentNote, SkipAPIAgentNoteType } from './agent-types.js';
|
|
21
21
|
/**
|
|
22
22
|
* Describes the different request phases that are used to communicate with the Skip API Server
|
|
23
23
|
* The phase of the conversation, defined as follows:
|
package/dist/api-types.js
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/**
|
|
3
2
|
* This file contains the fundamental API request and response types used for communication
|
|
4
3
|
* between client applications and the Skip API server. These types define the core data
|
|
@@ -12,8 +11,6 @@
|
|
|
12
11
|
* These types form the foundation of the Skip API communication protocol and are used
|
|
13
12
|
* across all Skip API interactions regardless of the specific functionality being invoked.
|
|
14
13
|
*/
|
|
15
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.SkipAPIRunScriptRequest = exports.SkipAPIResponse = exports.SkipAPIRequest = exports.MJAPISkipResult = exports.SkipResponsePhase = exports.SkipRequestPhase = void 0;
|
|
17
14
|
/**
|
|
18
15
|
* Describes the different request phases that are used to communicate with the Skip API Server
|
|
19
16
|
* The phase of the conversation, defined as follows:
|
|
@@ -24,7 +21,7 @@ exports.SkipAPIRunScriptRequest = exports.SkipAPIResponse = exports.SkipAPIReque
|
|
|
24
21
|
* * 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.
|
|
25
22
|
* * 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.
|
|
26
23
|
*/
|
|
27
|
-
|
|
24
|
+
export const SkipRequestPhase = {
|
|
28
25
|
initial_request: 'initial_request',
|
|
29
26
|
clarify_question_response: 'clarify_question_response',
|
|
30
27
|
data_gathering_response: 'data_gathering_response',
|
|
@@ -42,7 +39,7 @@ exports.SkipRequestPhase = {
|
|
|
42
39
|
* * 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
|
|
43
40
|
* * 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
|
|
44
41
|
*/
|
|
45
|
-
|
|
42
|
+
export const SkipResponsePhase = {
|
|
46
43
|
queued: "queued",
|
|
47
44
|
status_update: "status_update",
|
|
48
45
|
clarifying_question: "clarifying_question",
|
|
@@ -53,26 +50,22 @@ exports.SkipResponsePhase = {
|
|
|
53
50
|
/**
|
|
54
51
|
* This type defines the shape of data that is passed back from the MJ API server to callers, typically the MJ Explorer UI
|
|
55
52
|
*/
|
|
56
|
-
class MJAPISkipResult {
|
|
53
|
+
export class MJAPISkipResult {
|
|
57
54
|
}
|
|
58
|
-
exports.MJAPISkipResult = MJAPISkipResult;
|
|
59
55
|
/**
|
|
60
56
|
* Defines the shape of the data that is expected by the Skip API Server when making a request
|
|
61
57
|
*/
|
|
62
|
-
class SkipAPIRequest {
|
|
58
|
+
export class SkipAPIRequest {
|
|
63
59
|
}
|
|
64
|
-
exports.SkipAPIRequest = SkipAPIRequest;
|
|
65
60
|
/**
|
|
66
61
|
* Defines the shape of the data that is returned by the Skip API Server
|
|
67
62
|
*/
|
|
68
|
-
class SkipAPIResponse {
|
|
63
|
+
export class SkipAPIResponse {
|
|
69
64
|
}
|
|
70
|
-
exports.SkipAPIResponse = SkipAPIResponse;
|
|
71
65
|
/**
|
|
72
66
|
* Special API request type that extends the base SkipAPIRequest to include script execution capabilities.
|
|
73
67
|
* Used when the requestPhase is 'run_existing_script' to execute pre-defined script text.
|
|
74
68
|
*/
|
|
75
|
-
class SkipAPIRunScriptRequest extends SkipAPIRequest {
|
|
69
|
+
export class SkipAPIRunScriptRequest extends SkipAPIRequest {
|
|
76
70
|
}
|
|
77
|
-
exports.SkipAPIRunScriptRequest = SkipAPIRunScriptRequest;
|
|
78
71
|
//# sourceMappingURL=api-types.js.map
|
package/dist/api-types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api-types.js","sourceRoot":"","sources":["../src/api-types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"api-types.js","sourceRoot":"","sources":["../src/api-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAUH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,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;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC7B,MAAM,EAAE,QAAQ;IAChB,aAAa,EAAE,eAAe;IAC9B,mBAAmB,EAAE,qBAAqB;IAC1C,YAAY,EAAE,cAAc;IAC5B,iBAAiB,EAAE,mBAAmB;IACtC,2BAA2B,EAAE,6BAA6B;CACpD,CAAC;AAGX;;GAEG;AACH,MAAM,OAAO,eAAe;CAgD3B;AAED;;GAEG;AACH,MAAM,OAAO,cAAc;CAgG1B;AAED;;GAEG;AACH,MAAM,OAAO,eAAe;CA8B3B;AAED;;;GAGG;AACH,MAAM,OAAO,uBAAwB,SAAQ,cAAc;CAK1D"}
|
package/dist/artifact-types.js
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/**
|
|
3
2
|
* This file contains types related to artifacts - persistent objects created and managed
|
|
4
3
|
* through Skip conversations. These types define the structure for:
|
|
@@ -17,5 +16,5 @@
|
|
|
17
16
|
* AI-generated content and compare different iterations. It also includes sharing
|
|
18
17
|
* capabilities and user feedback mechanisms to improve future artifact generation.
|
|
19
18
|
*/
|
|
20
|
-
|
|
19
|
+
export {};
|
|
21
20
|
//# sourceMappingURL=artifact-types.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"artifact-types.js","sourceRoot":"","sources":["../src/artifact-types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"artifact-types.js","sourceRoot":"","sources":["../src/artifact-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG"}
|
package/dist/auth-types.js
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/**
|
|
3
2
|
* This file contains types related to authentication and API key management
|
|
4
3
|
* within the Skip API system. These types define the structure for:
|
|
@@ -14,14 +13,11 @@
|
|
|
14
13
|
* AI namespace that provide standardized interfaces to different AI providers
|
|
15
14
|
* such as OpenAI, Anthropic, Google, and others.
|
|
16
15
|
*/
|
|
17
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
-
exports.SkipAPIRequestAPIKey = void 0;
|
|
19
16
|
/**
|
|
20
17
|
* Defines the API key information for AI service providers that Skip will use
|
|
21
18
|
* on behalf of the client. Skip never stores these credentials - they are only
|
|
22
19
|
* used for the duration of the request to access the specified AI services.
|
|
23
20
|
*/
|
|
24
|
-
class SkipAPIRequestAPIKey {
|
|
21
|
+
export class SkipAPIRequestAPIKey {
|
|
25
22
|
}
|
|
26
|
-
exports.SkipAPIRequestAPIKey = SkipAPIRequestAPIKey;
|
|
27
23
|
//# sourceMappingURL=auth-types.js.map
|
package/dist/auth-types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"auth-types.js","sourceRoot":"","sources":["../src/auth-types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"auth-types.js","sourceRoot":"","sources":["../src/auth-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH;;;;GAIG;AACH,MAAM,OAAO,oBAAoB;CAYhC"}
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
* Sub-process responses are used when Skip executes code in a sandboxed environment and needs
|
|
15
15
|
* to communicate the results back to the main API server.
|
|
16
16
|
*/
|
|
17
|
-
import type { SkipAPIArtifact } from './artifact-types';
|
|
17
|
+
import type { SkipAPIArtifact } from './artifact-types.js';
|
|
18
18
|
/**
|
|
19
19
|
* Whenever Skip executes it's analysis phase, it uses a sandboxed sub-process to execute code securely and
|
|
20
20
|
* this shape of data is used to communicate the results of that sub-process back to the Skip API server.
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/**
|
|
3
2
|
* This file contains types related to conversations and messaging within the Skip API system.
|
|
4
3
|
* These types define the structure for:
|
|
@@ -15,27 +14,22 @@
|
|
|
15
14
|
* Sub-process responses are used when Skip executes code in a sandboxed environment and needs
|
|
16
15
|
* to communicate the results back to the main API server.
|
|
17
16
|
*/
|
|
18
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.SkipMessage = exports.SkipConversation = exports.SkipSubProcessResponse = void 0;
|
|
20
17
|
/**
|
|
21
18
|
* Whenever Skip executes it's analysis phase, it uses a sandboxed sub-process to execute code securely and
|
|
22
19
|
* this shape of data is used to communicate the results of that sub-process back to the Skip API server.
|
|
23
20
|
* This data type is in turn used within the SkipAPIAnalysisCompleteResponse type.
|
|
24
21
|
*/
|
|
25
|
-
class SkipSubProcessResponse {
|
|
22
|
+
export class SkipSubProcessResponse {
|
|
26
23
|
}
|
|
27
|
-
exports.SkipSubProcessResponse = SkipSubProcessResponse;
|
|
28
24
|
/**
|
|
29
25
|
* 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
|
|
30
26
|
*/
|
|
31
|
-
class SkipConversation {
|
|
27
|
+
export class SkipConversation {
|
|
32
28
|
}
|
|
33
|
-
exports.SkipConversation = SkipConversation;
|
|
34
29
|
/**
|
|
35
30
|
* Defines the shape of the individual message that makes up the messages array that is passed back and
|
|
36
31
|
* forth with the Skip API Server
|
|
37
32
|
*/
|
|
38
|
-
class SkipMessage {
|
|
33
|
+
export class SkipMessage {
|
|
39
34
|
}
|
|
40
|
-
exports.SkipMessage = SkipMessage;
|
|
41
35
|
//# sourceMappingURL=conversation-types.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"conversation-types.js","sourceRoot":"","sources":["../src/conversation-types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"conversation-types.js","sourceRoot":"","sources":["../src/conversation-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAIH;;;;GAIG;AACH,MAAM,OAAO,sBAAsB;CAclC;AAED;;GAEG;AACH,MAAM,OAAO,gBAAgB;CA0C5B;AAED;;;GAGG;AACH,MAAM,OAAO,WAAW;CAuDvB"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
export * from './api-types';
|
|
2
|
-
export * from './conversation-types';
|
|
3
|
-
export * from './response-types';
|
|
4
|
-
export * from './entity-metadata-types';
|
|
5
|
-
export * from './query-types';
|
|
6
|
-
export * from './agent-types';
|
|
7
|
-
export * from './artifact-types';
|
|
8
|
-
export * from './auth-types';
|
|
9
|
-
export * from './util';
|
|
1
|
+
export * from './api-types.js';
|
|
2
|
+
export * from './conversation-types.js';
|
|
3
|
+
export * from './response-types.js';
|
|
4
|
+
export * from './entity-metadata-types.js';
|
|
5
|
+
export * from './query-types.js';
|
|
6
|
+
export * from './agent-types.js';
|
|
7
|
+
export * from './artifact-types.js';
|
|
8
|
+
export * from './auth-types.js';
|
|
9
|
+
export * from './util.js';
|
|
10
10
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.js
CHANGED
|
@@ -1,27 +1,11 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
-
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
-
};
|
|
16
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
1
|
// Re-export all types from organized modules
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
2
|
+
export * from './api-types.js';
|
|
3
|
+
export * from './conversation-types.js';
|
|
4
|
+
export * from './response-types.js';
|
|
5
|
+
export * from './entity-metadata-types.js';
|
|
6
|
+
export * from './query-types.js';
|
|
7
|
+
export * from './agent-types.js';
|
|
8
|
+
export * from './artifact-types.js';
|
|
9
|
+
export * from './auth-types.js';
|
|
10
|
+
export * from './util.js';
|
|
27
11
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,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;AAE7B,cAAc,QAAQ,CAAC"}
|
package/dist/query-types.js
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/**
|
|
3
2
|
* This file contains types related to database queries, stored queries, and data requests
|
|
4
3
|
* within the Skip API system. These types define the structure for:
|
|
@@ -19,23 +18,20 @@
|
|
|
19
18
|
* IMPORTANT: These types implement interfaces from @memberjunction/core to ensure
|
|
20
19
|
* consistency between MJ and Skip. Property names use PascalCase to match MJ conventions.
|
|
21
20
|
*/
|
|
22
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
23
|
-
exports.SkipLearningCycleQueryChange = exports.SkipQueryInfo = exports.SkipQueryEntityInfo = exports.SkipQueryParamInfo = exports.SkipQueryFieldInfo = exports.SkipDataRequest = exports.SkipDataRequestType = void 0;
|
|
24
21
|
/**
|
|
25
22
|
* Describes the different types of data requests the Skip API server can make for additional data.
|
|
26
23
|
* * sql: The Skip API server is asking for additional data to be gathered using a fully executable SQL statement
|
|
27
24
|
* * 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.
|
|
28
25
|
*/
|
|
29
|
-
|
|
26
|
+
export const SkipDataRequestType = {
|
|
30
27
|
sql: "sql",
|
|
31
28
|
stored_query: "stored_query"
|
|
32
29
|
};
|
|
33
30
|
/**
|
|
34
31
|
* This type is used to define the requested data whenever the Skip API server asks for additional data to be gathered
|
|
35
32
|
*/
|
|
36
|
-
class SkipDataRequest {
|
|
33
|
+
export class SkipDataRequest {
|
|
37
34
|
}
|
|
38
|
-
exports.SkipDataRequest = SkipDataRequest;
|
|
39
35
|
/**
|
|
40
36
|
* Metadata about individual fields within a stored query, including their data types,
|
|
41
37
|
* source entity mappings, and computed field information. This helps Skip understand
|
|
@@ -43,27 +39,24 @@ exports.SkipDataRequest = SkipDataRequest;
|
|
|
43
39
|
*
|
|
44
40
|
* Implements IQueryFieldInfoBase for consistency with MJCore types.
|
|
45
41
|
*/
|
|
46
|
-
class SkipQueryFieldInfo {
|
|
42
|
+
export class SkipQueryFieldInfo {
|
|
47
43
|
}
|
|
48
|
-
exports.SkipQueryFieldInfo = SkipQueryFieldInfo;
|
|
49
44
|
/**
|
|
50
45
|
* Parameter definitions for parameterized queries that use Nunjucks templates.
|
|
51
46
|
* Each parameter represents a dynamic value that can be passed when executing the query.
|
|
52
47
|
*
|
|
53
48
|
* Implements IQueryParameterInfoBase for consistency with MJCore types.
|
|
54
49
|
*/
|
|
55
|
-
class SkipQueryParamInfo {
|
|
50
|
+
export class SkipQueryParamInfo {
|
|
56
51
|
}
|
|
57
|
-
exports.SkipQueryParamInfo = SkipQueryParamInfo;
|
|
58
52
|
/**
|
|
59
53
|
* Metadata about entities referenced by a query. This helps Skip understand which
|
|
60
54
|
* entities are involved in each query and how they are being used.
|
|
61
55
|
*
|
|
62
56
|
* Implements IQueryEntityInfoBase for consistency with MJCore types.
|
|
63
57
|
*/
|
|
64
|
-
class SkipQueryEntityInfo {
|
|
58
|
+
export class SkipQueryEntityInfo {
|
|
65
59
|
}
|
|
66
|
-
exports.SkipQueryEntityInfo = SkipQueryEntityInfo;
|
|
67
60
|
/**
|
|
68
61
|
* Complete metadata about a stored query, including its SQL, approval status, quality ranking,
|
|
69
62
|
* and field definitions. This information allows Skip to understand and utilize pre-built
|
|
@@ -71,18 +64,16 @@ exports.SkipQueryEntityInfo = SkipQueryEntityInfo;
|
|
|
71
64
|
*
|
|
72
65
|
* Implements IQueryInfoBase for consistency with MJCore types.
|
|
73
66
|
*/
|
|
74
|
-
class SkipQueryInfo {
|
|
67
|
+
export class SkipQueryInfo {
|
|
75
68
|
constructor() {
|
|
76
69
|
this.CacheEnabled = false;
|
|
77
70
|
}
|
|
78
71
|
}
|
|
79
|
-
exports.SkipQueryInfo = SkipQueryInfo;
|
|
80
72
|
/**
|
|
81
73
|
* Represents a change to a query during the learning cycle process, allowing Skip
|
|
82
74
|
* to add new queries, update existing ones, or mark queries for deletion based on
|
|
83
75
|
* its analysis of conversation patterns and user needs.
|
|
84
76
|
*/
|
|
85
|
-
class SkipLearningCycleQueryChange {
|
|
77
|
+
export class SkipLearningCycleQueryChange {
|
|
86
78
|
}
|
|
87
|
-
exports.SkipLearningCycleQueryChange = SkipLearningCycleQueryChange;
|
|
88
79
|
//# sourceMappingURL=query-types.js.map
|
package/dist/query-types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"query-types.js","sourceRoot":"","sources":["../src/query-types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"query-types.js","sourceRoot":"","sources":["../src/query-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AASH;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IAC/B,GAAG,EAAE,KAAK;IACV,YAAY,EAAE,cAAc;CACtB,CAAC;AAGX;;GAEG;AACH,MAAM,OAAO,eAAe;CAmB3B;AAED;;;;;;GAMG;AACH,MAAM,OAAO,kBAAkB;CAyD9B;AAED;;;;;GAKG;AACH,MAAM,OAAO,kBAAkB;CAqC9B;AAED;;;;;GAKG;AACH,MAAM,OAAO,mBAAmB;CAiB/B;AAED;;;;;;GAMG;AACH,MAAM,OAAO,aAAa;IAA1B;QA8DI,iBAAY,GAAY,KAAK,CAAC;IAIlC,CAAC;CAAA;AAED;;;;GAIG;AACH,MAAM,OAAO,4BAA4B;CAGxC"}
|
package/dist/response-types.d.ts
CHANGED
|
@@ -15,11 +15,11 @@
|
|
|
15
15
|
* The analysis complete response is particularly comprehensive, containing component data,
|
|
16
16
|
* explanations, column metadata, drill-down information, and component options.
|
|
17
17
|
*/
|
|
18
|
-
import { SkipAPIResponse } from './api-types';
|
|
19
|
-
import type { SkipSubProcessResponse } from './conversation-types';
|
|
20
|
-
import type { SkipColumnInfo } from './entity-metadata-types';
|
|
21
|
-
import type { SkipDataRequest } from './query-types';
|
|
22
|
-
import type { SkipAPIArtifactRequest } from './artifact-types';
|
|
18
|
+
import { SkipAPIResponse } from './api-types.js';
|
|
19
|
+
import type { SkipSubProcessResponse } from './conversation-types.js';
|
|
20
|
+
import type { SkipColumnInfo } from './entity-metadata-types.js';
|
|
21
|
+
import type { SkipDataRequest } from './query-types.js';
|
|
22
|
+
import type { SkipAPIArtifactRequest } from './artifact-types.js';
|
|
23
23
|
import { ComponentOption, SimpleDataContext } from '@memberjunction/interactive-component-types';
|
|
24
24
|
import { AgentResponseForm } from '@memberjunction/ai-core-plus';
|
|
25
25
|
/**
|
package/dist/response-types.js
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/**
|
|
3
2
|
* This file contains specialized response types that extend the base SkipAPIResponse for different
|
|
4
3
|
* response phases and scenarios. These types define the structure for:
|
|
@@ -16,43 +15,35 @@
|
|
|
16
15
|
* The analysis complete response is particularly comprehensive, containing component data,
|
|
17
16
|
* explanations, column metadata, drill-down information, and component options.
|
|
18
17
|
*/
|
|
19
|
-
|
|
20
|
-
exports.SkipAPIChatWithRecordResponse = exports.SkipAPIDataRequestResponse = exports.SkipAPIClarifyingQuestionResponse = exports.SkipAPIAnalysisCompleteResponse = exports.SkipAPIAnalysisDrillDown = exports.SkipAPIAnalysisDrillDownFilter = void 0;
|
|
21
|
-
const api_types_1 = require("./api-types");
|
|
18
|
+
import { SkipAPIResponse } from './api-types.js';
|
|
22
19
|
/**
|
|
23
20
|
* 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
|
|
24
21
|
*/
|
|
25
|
-
class SkipAPIAnalysisDrillDownFilter {
|
|
22
|
+
export class SkipAPIAnalysisDrillDownFilter {
|
|
26
23
|
}
|
|
27
|
-
exports.SkipAPIAnalysisDrillDownFilter = SkipAPIAnalysisDrillDownFilter;
|
|
28
24
|
/**
|
|
29
25
|
* 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
|
|
30
26
|
*/
|
|
31
|
-
class SkipAPIAnalysisDrillDown {
|
|
27
|
+
export class SkipAPIAnalysisDrillDown {
|
|
32
28
|
}
|
|
33
|
-
exports.SkipAPIAnalysisDrillDown = SkipAPIAnalysisDrillDown;
|
|
34
29
|
/**
|
|
35
30
|
* Defines the shape of the data that is returned by the Skip API Server when the responsePhase is 'analysis_complete'
|
|
36
31
|
*/
|
|
37
|
-
class SkipAPIAnalysisCompleteResponse extends
|
|
32
|
+
export class SkipAPIAnalysisCompleteResponse extends SkipAPIResponse {
|
|
38
33
|
}
|
|
39
|
-
exports.SkipAPIAnalysisCompleteResponse = SkipAPIAnalysisCompleteResponse;
|
|
40
34
|
/**
|
|
41
35
|
* Defines the shape of the data that is returned by the Skip API Server when the responsePhase is 'clarifying_question'
|
|
42
36
|
*/
|
|
43
|
-
class SkipAPIClarifyingQuestionResponse extends
|
|
37
|
+
export class SkipAPIClarifyingQuestionResponse extends SkipAPIResponse {
|
|
44
38
|
}
|
|
45
|
-
exports.SkipAPIClarifyingQuestionResponse = SkipAPIClarifyingQuestionResponse;
|
|
46
39
|
/**
|
|
47
40
|
* Defines the shape of the data that is returned by the Skip API Server when the responsePhase is 'data_request'
|
|
48
41
|
*/
|
|
49
|
-
class SkipAPIDataRequestResponse extends
|
|
42
|
+
export class SkipAPIDataRequestResponse extends SkipAPIResponse {
|
|
50
43
|
}
|
|
51
|
-
exports.SkipAPIDataRequestResponse = SkipAPIDataRequestResponse;
|
|
52
44
|
/**
|
|
53
45
|
* Defines the shape of the data that is returned by the Skip API Server when the responsePhase is 'chat_with_a_record_complete'
|
|
54
46
|
*/
|
|
55
|
-
class SkipAPIChatWithRecordResponse extends
|
|
47
|
+
export class SkipAPIChatWithRecordResponse extends SkipAPIResponse {
|
|
56
48
|
}
|
|
57
|
-
exports.SkipAPIChatWithRecordResponse = SkipAPIChatWithRecordResponse;
|
|
58
49
|
//# sourceMappingURL=response-types.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"response-types.js","sourceRoot":"","sources":["../src/response-types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"response-types.js","sourceRoot":"","sources":["../src/response-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAQ9C;;GAEG;AACH,MAAM,OAAO,8BAA8B;CAG1C;AAED;;GAEG;AACH,MAAM,OAAO,wBAAwB;CAepC;AAED;;GAEG;AACH,MAAM,OAAO,+BAAgC,SAAQ,eAAe;CAyEnE;AAED;;GAEG;AACH,MAAM,OAAO,iCAAkC,SAAQ,eAAe;CAiBrE;AAED;;GAEG;AACH,MAAM,OAAO,0BAA2B,SAAQ,eAAe;CAE9D;AAED;;GAEG;AACH,MAAM,OAAO,6BAA8B,SAAQ,eAAe;CAKjE"}
|
package/dist/util.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { EntityFieldInfo, EntityFieldValueInfo, EntityInfo, EntityRelationshipInfo } from "@memberjunction/core";
|
|
2
2
|
import { SimpleEntityInfo, SimpleEntityFieldInfo } from "@memberjunction/interactive-component-types";
|
|
3
|
-
import { SkipEntityFieldInfo, SkipEntityFieldValueInfo, SkipEntityInfo, SkipEntityRelationshipInfo } from "./entity-metadata-types";
|
|
3
|
+
import { SkipEntityFieldInfo, SkipEntityFieldValueInfo, SkipEntityInfo, SkipEntityRelationshipInfo } from "./entity-metadata-types.js";
|
|
4
4
|
/**
|
|
5
5
|
* Maps a MemberJunction EntityInfo object to a SkipEntityInfo object for use in the Skip query system.
|
|
6
6
|
*
|
package/dist/util.js
CHANGED
|
@@ -1,7 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.skipEntityGetFieldNameSet = exports.skipEntityGetField = exports.skipEntityHasField = exports.MapSkipEntityFieldInfoToSimpleEntityFieldInfo = exports.MapSimpleEntityFieldInfoToSkipEntityFieldInfo = exports.MapSkipEntityInfoToSimpleEntityInfo = exports.MapSimpleEntityInfoArrayToSkipEntityInfoArray = exports.MapSimpleEntityInfoToSkipEntityInfo = exports.MapEntityRelationshipInfoToSkipEntityRelationshipInfo = exports.MapEntityFieldValueInfoToSkipEntityFieldValueInfo = exports.MapSkipEntityFieldInfoToEntityFieldInfo = exports.MapEntityFieldInfoToSkipEntityFieldInfo = exports.MapSkipEntityInfoToEntityInfo = exports.MapEntityInfoArrayToSkipEntityInfoArray = exports.MapEntityInfoToSkipEntityInfo = void 0;
|
|
4
|
-
const interactive_component_types_1 = require("@memberjunction/interactive-component-types");
|
|
1
|
+
import { SimpleEntityInfo, SimpleEntityFieldInfo } from "@memberjunction/interactive-component-types";
|
|
5
2
|
// ============================================================================
|
|
6
3
|
// EntityInfo <-> SkipEntityInfo conversions
|
|
7
4
|
// ============================================================================
|
|
@@ -14,7 +11,7 @@ const interactive_component_types_1 = require("@memberjunction/interactive-compo
|
|
|
14
11
|
* @param e - The source EntityInfo object from MemberJunction core
|
|
15
12
|
* @returns A SkipEntityInfo object with mapped fields and relationships
|
|
16
13
|
*/
|
|
17
|
-
function MapEntityInfoToSkipEntityInfo(e) {
|
|
14
|
+
export function MapEntityInfoToSkipEntityInfo(e) {
|
|
18
15
|
return {
|
|
19
16
|
id: e.ID,
|
|
20
17
|
name: e.Name,
|
|
@@ -27,17 +24,15 @@ function MapEntityInfoToSkipEntityInfo(e) {
|
|
|
27
24
|
rowsSampleMethod: e.RowsToPackSampleMethod
|
|
28
25
|
};
|
|
29
26
|
}
|
|
30
|
-
exports.MapEntityInfoToSkipEntityInfo = MapEntityInfoToSkipEntityInfo;
|
|
31
27
|
/**
|
|
32
28
|
* Maps an array of MemberJunction EntityInfo objects to SkipEntityInfo objects.
|
|
33
29
|
*
|
|
34
30
|
* @param entities - Array of EntityInfo from @memberjunction/core
|
|
35
31
|
* @returns Array of SkipEntityInfo objects
|
|
36
32
|
*/
|
|
37
|
-
function MapEntityInfoArrayToSkipEntityInfoArray(entities) {
|
|
33
|
+
export function MapEntityInfoArrayToSkipEntityInfoArray(entities) {
|
|
38
34
|
return entities.map(e => MapEntityInfoToSkipEntityInfo(e));
|
|
39
35
|
}
|
|
40
|
-
exports.MapEntityInfoArrayToSkipEntityInfoArray = MapEntityInfoArrayToSkipEntityInfoArray;
|
|
41
36
|
/**
|
|
42
37
|
* Converts a SkipEntityInfo to a partial EntityInfo object.
|
|
43
38
|
* Note: This creates a plain object with EntityInfo-compatible properties,
|
|
@@ -46,7 +41,7 @@ exports.MapEntityInfoArrayToSkipEntityInfoArray = MapEntityInfoArrayToSkipEntity
|
|
|
46
41
|
* @param skipEntity - The SkipEntityInfo to convert
|
|
47
42
|
* @returns A partial EntityInfo-compatible object
|
|
48
43
|
*/
|
|
49
|
-
function MapSkipEntityInfoToEntityInfo(skipEntity) {
|
|
44
|
+
export function MapSkipEntityInfoToEntityInfo(skipEntity) {
|
|
50
45
|
return {
|
|
51
46
|
ID: skipEntity.id,
|
|
52
47
|
Name: skipEntity.name,
|
|
@@ -57,7 +52,6 @@ function MapSkipEntityInfoToEntityInfo(skipEntity) {
|
|
|
57
52
|
RowsToPackSampleMethod: skipEntity.rowsSampleMethod
|
|
58
53
|
};
|
|
59
54
|
}
|
|
60
|
-
exports.MapSkipEntityInfoToEntityInfo = MapSkipEntityInfoToEntityInfo;
|
|
61
55
|
// ============================================================================
|
|
62
56
|
// EntityFieldInfo <-> SkipEntityFieldInfo conversions
|
|
63
57
|
// ============================================================================
|
|
@@ -71,7 +65,7 @@ exports.MapSkipEntityInfoToEntityInfo = MapSkipEntityInfoToEntityInfo;
|
|
|
71
65
|
* @param f - The EntityFieldInfo object to be mapped
|
|
72
66
|
* @returns A SkipEntityFieldInfo object with all field properties mapped
|
|
73
67
|
*/
|
|
74
|
-
function MapEntityFieldInfoToSkipEntityFieldInfo(f) {
|
|
68
|
+
export function MapEntityFieldInfoToSkipEntityFieldInfo(f) {
|
|
75
69
|
return {
|
|
76
70
|
entityID: f.EntityID,
|
|
77
71
|
sequence: f.Sequence,
|
|
@@ -106,7 +100,6 @@ function MapEntityFieldInfoToSkipEntityFieldInfo(f) {
|
|
|
106
100
|
}))
|
|
107
101
|
};
|
|
108
102
|
}
|
|
109
|
-
exports.MapEntityFieldInfoToSkipEntityFieldInfo = MapEntityFieldInfoToSkipEntityFieldInfo;
|
|
110
103
|
/**
|
|
111
104
|
* Converts a SkipEntityFieldInfo to a partial EntityFieldInfo object.
|
|
112
105
|
* Note: This creates a plain object with EntityFieldInfo-compatible properties,
|
|
@@ -115,7 +108,7 @@ exports.MapEntityFieldInfoToSkipEntityFieldInfo = MapEntityFieldInfoToSkipEntity
|
|
|
115
108
|
* @param skipField - The SkipEntityFieldInfo to convert
|
|
116
109
|
* @returns A partial EntityFieldInfo-compatible object
|
|
117
110
|
*/
|
|
118
|
-
function MapSkipEntityFieldInfoToEntityFieldInfo(skipField) {
|
|
111
|
+
export function MapSkipEntityFieldInfoToEntityFieldInfo(skipField) {
|
|
119
112
|
return {
|
|
120
113
|
EntityID: skipField.entityID,
|
|
121
114
|
Sequence: skipField.sequence,
|
|
@@ -142,7 +135,6 @@ function MapSkipEntityFieldInfoToEntityFieldInfo(skipField) {
|
|
|
142
135
|
RelatedEntityFieldName: skipField.relatedEntityFieldName
|
|
143
136
|
};
|
|
144
137
|
}
|
|
145
|
-
exports.MapSkipEntityFieldInfoToEntityFieldInfo = MapSkipEntityFieldInfoToEntityFieldInfo;
|
|
146
138
|
// ============================================================================
|
|
147
139
|
// EntityFieldValueInfo <-> SkipEntityFieldValueInfo conversions
|
|
148
140
|
// ============================================================================
|
|
@@ -156,13 +148,12 @@ exports.MapSkipEntityFieldInfoToEntityFieldInfo = MapSkipEntityFieldInfoToEntity
|
|
|
156
148
|
* @param pv - The EntityFieldValueInfo object representing a possible value
|
|
157
149
|
* @returns A SkipEntityFieldValueInfo object with mapped value information
|
|
158
150
|
*/
|
|
159
|
-
function MapEntityFieldValueInfoToSkipEntityFieldValueInfo(pv) {
|
|
151
|
+
export function MapEntityFieldValueInfoToSkipEntityFieldValueInfo(pv) {
|
|
160
152
|
return {
|
|
161
153
|
value: pv.Value,
|
|
162
154
|
displayValue: pv.Value
|
|
163
155
|
};
|
|
164
156
|
}
|
|
165
|
-
exports.MapEntityFieldValueInfoToSkipEntityFieldValueInfo = MapEntityFieldValueInfoToSkipEntityFieldValueInfo;
|
|
166
157
|
// ============================================================================
|
|
167
158
|
// EntityRelationshipInfo <-> SkipEntityRelationshipInfo conversions
|
|
168
159
|
// ============================================================================
|
|
@@ -176,7 +167,7 @@ exports.MapEntityFieldValueInfoToSkipEntityFieldValueInfo = MapEntityFieldValueI
|
|
|
176
167
|
* @param re - The EntityRelationshipInfo object to be mapped
|
|
177
168
|
* @returns A SkipEntityRelationshipInfo object with all relationship properties mapped
|
|
178
169
|
*/
|
|
179
|
-
function MapEntityRelationshipInfoToSkipEntityRelationshipInfo(re) {
|
|
170
|
+
export function MapEntityRelationshipInfoToSkipEntityRelationshipInfo(re) {
|
|
180
171
|
return {
|
|
181
172
|
entityID: re.EntityID,
|
|
182
173
|
entity: re.Entity,
|
|
@@ -192,7 +183,6 @@ function MapEntityRelationshipInfoToSkipEntityRelationshipInfo(re) {
|
|
|
192
183
|
joinEntityJoinField: re.JoinEntityJoinField,
|
|
193
184
|
};
|
|
194
185
|
}
|
|
195
|
-
exports.MapEntityRelationshipInfoToSkipEntityRelationshipInfo = MapEntityRelationshipInfoToSkipEntityRelationshipInfo;
|
|
196
186
|
// ============================================================================
|
|
197
187
|
// SimpleEntityInfo <-> SkipEntityInfo conversions
|
|
198
188
|
// ============================================================================
|
|
@@ -202,7 +192,7 @@ exports.MapEntityRelationshipInfoToSkipEntityRelationshipInfo = MapEntityRelatio
|
|
|
202
192
|
* @param simpleEntity - The SimpleEntityInfo from @memberjunction/interactive-component-types
|
|
203
193
|
* @returns A SkipEntityInfo object
|
|
204
194
|
*/
|
|
205
|
-
function MapSimpleEntityInfoToSkipEntityInfo(simpleEntity) {
|
|
195
|
+
export function MapSimpleEntityInfoToSkipEntityInfo(simpleEntity) {
|
|
206
196
|
return {
|
|
207
197
|
id: '',
|
|
208
198
|
name: simpleEntity.name,
|
|
@@ -213,31 +203,28 @@ function MapSimpleEntityInfoToSkipEntityInfo(simpleEntity) {
|
|
|
213
203
|
relatedEntities: []
|
|
214
204
|
};
|
|
215
205
|
}
|
|
216
|
-
exports.MapSimpleEntityInfoToSkipEntityInfo = MapSimpleEntityInfoToSkipEntityInfo;
|
|
217
206
|
/**
|
|
218
207
|
* Maps an array of SimpleEntityInfo objects to SkipEntityInfo objects.
|
|
219
208
|
*
|
|
220
209
|
* @param entities - Array of SimpleEntityInfo from @memberjunction/interactive-component-types
|
|
221
210
|
* @returns Array of SkipEntityInfo objects
|
|
222
211
|
*/
|
|
223
|
-
function MapSimpleEntityInfoArrayToSkipEntityInfoArray(entities) {
|
|
212
|
+
export function MapSimpleEntityInfoArrayToSkipEntityInfoArray(entities) {
|
|
224
213
|
return entities.map(e => MapSimpleEntityInfoToSkipEntityInfo(e));
|
|
225
214
|
}
|
|
226
|
-
exports.MapSimpleEntityInfoArrayToSkipEntityInfoArray = MapSimpleEntityInfoArrayToSkipEntityInfoArray;
|
|
227
215
|
/**
|
|
228
216
|
* Converts a SkipEntityInfo to a SimpleEntityInfo object.
|
|
229
217
|
*
|
|
230
218
|
* @param skipEntity - The SkipEntityInfo to convert
|
|
231
219
|
* @returns A new SimpleEntityInfo instance
|
|
232
220
|
*/
|
|
233
|
-
function MapSkipEntityInfoToSimpleEntityInfo(skipEntity) {
|
|
234
|
-
return new
|
|
221
|
+
export function MapSkipEntityInfoToSimpleEntityInfo(skipEntity) {
|
|
222
|
+
return new SimpleEntityInfo({
|
|
235
223
|
name: skipEntity.name,
|
|
236
224
|
description: skipEntity.description,
|
|
237
225
|
fields: skipEntity.fields.map(f => MapSkipEntityFieldInfoToSimpleEntityFieldInfo(f))
|
|
238
226
|
});
|
|
239
227
|
}
|
|
240
|
-
exports.MapSkipEntityInfoToSimpleEntityInfo = MapSkipEntityInfoToSimpleEntityInfo;
|
|
241
228
|
// ============================================================================
|
|
242
229
|
// SimpleEntityFieldInfo <-> SkipEntityFieldInfo conversions
|
|
243
230
|
// ============================================================================
|
|
@@ -247,7 +234,7 @@ exports.MapSkipEntityInfoToSimpleEntityInfo = MapSkipEntityInfoToSimpleEntityInf
|
|
|
247
234
|
* @param simpleField - The SimpleEntityFieldInfo from @memberjunction/interactive-component-types
|
|
248
235
|
* @returns A SkipEntityFieldInfo object
|
|
249
236
|
*/
|
|
250
|
-
function MapSimpleEntityFieldInfoToSkipEntityFieldInfo(simpleField) {
|
|
237
|
+
export function MapSimpleEntityFieldInfoToSkipEntityFieldInfo(simpleField) {
|
|
251
238
|
return {
|
|
252
239
|
entityID: '',
|
|
253
240
|
sequence: simpleField.sequence,
|
|
@@ -279,15 +266,14 @@ function MapSimpleEntityFieldInfoToSkipEntityFieldInfo(simpleField) {
|
|
|
279
266
|
possibleValues: simpleField.possibleValues?.map(v => ({ value: v }))
|
|
280
267
|
};
|
|
281
268
|
}
|
|
282
|
-
exports.MapSimpleEntityFieldInfoToSkipEntityFieldInfo = MapSimpleEntityFieldInfoToSkipEntityFieldInfo;
|
|
283
269
|
/**
|
|
284
270
|
* Converts a SkipEntityFieldInfo to a SimpleEntityFieldInfo object.
|
|
285
271
|
*
|
|
286
272
|
* @param skipField - The SkipEntityFieldInfo to convert
|
|
287
273
|
* @returns A new SimpleEntityFieldInfo instance
|
|
288
274
|
*/
|
|
289
|
-
function MapSkipEntityFieldInfoToSimpleEntityFieldInfo(skipField) {
|
|
290
|
-
return new
|
|
275
|
+
export function MapSkipEntityFieldInfoToSimpleEntityFieldInfo(skipField) {
|
|
276
|
+
return new SimpleEntityFieldInfo({
|
|
291
277
|
name: skipField.name,
|
|
292
278
|
sequence: skipField.sequence,
|
|
293
279
|
defaultInView: skipField.defaultInView,
|
|
@@ -298,7 +284,6 @@ function MapSkipEntityFieldInfoToSimpleEntityFieldInfo(skipField) {
|
|
|
298
284
|
possibleValues: skipField.possibleValues?.map(v => v.value)
|
|
299
285
|
});
|
|
300
286
|
}
|
|
301
|
-
exports.MapSkipEntityFieldInfoToSimpleEntityFieldInfo = MapSkipEntityFieldInfoToSimpleEntityFieldInfo;
|
|
302
287
|
// ============================================================================
|
|
303
288
|
// Helper functions for working with SkipEntityInfo
|
|
304
289
|
// ============================================================================
|
|
@@ -309,10 +294,9 @@ exports.MapSkipEntityFieldInfoToSimpleEntityFieldInfo = MapSkipEntityFieldInfoTo
|
|
|
309
294
|
* @param fieldName - The field name to check
|
|
310
295
|
* @returns True if the field exists, false otherwise
|
|
311
296
|
*/
|
|
312
|
-
function skipEntityHasField(entity, fieldName) {
|
|
297
|
+
export function skipEntityHasField(entity, fieldName) {
|
|
313
298
|
return entity.fields.some(f => f.name === fieldName);
|
|
314
299
|
}
|
|
315
|
-
exports.skipEntityHasField = skipEntityHasField;
|
|
316
300
|
/**
|
|
317
301
|
* Helper function to get a field by name from a SkipEntityInfo
|
|
318
302
|
*
|
|
@@ -320,18 +304,16 @@ exports.skipEntityHasField = skipEntityHasField;
|
|
|
320
304
|
* @param fieldName - The field name to find
|
|
321
305
|
* @returns The SkipEntityFieldInfo if found, undefined otherwise
|
|
322
306
|
*/
|
|
323
|
-
function skipEntityGetField(entity, fieldName) {
|
|
307
|
+
export function skipEntityGetField(entity, fieldName) {
|
|
324
308
|
return entity.fields.find(f => f.name === fieldName);
|
|
325
309
|
}
|
|
326
|
-
exports.skipEntityGetField = skipEntityGetField;
|
|
327
310
|
/**
|
|
328
311
|
* Helper function to get all field names as a Set for efficient lookup
|
|
329
312
|
*
|
|
330
313
|
* @param entity - The SkipEntityInfo to get field names from
|
|
331
314
|
* @returns Set of all field names in the entity
|
|
332
315
|
*/
|
|
333
|
-
function skipEntityGetFieldNameSet(entity) {
|
|
316
|
+
export function skipEntityGetFieldNameSet(entity) {
|
|
334
317
|
return new Set(entity.fields.map(f => f.name));
|
|
335
318
|
}
|
|
336
|
-
exports.skipEntityGetFieldNameSet = skipEntityGetFieldNameSet;
|
|
337
319
|
//# sourceMappingURL=util.js.map
|
package/dist/util.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,6CAA6C,CAAC;AAGtG,+EAA+E;AAC/E,4CAA4C;AAC5C,+EAA+E;AAE/E;;;;;;;;GAQG;AACH,MAAM,UAAU,6BAA6B,CAAC,CAAa;IACvD,OAAO;QACH,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,UAAU,EAAE,CAAC,CAAC,UAAU;QACxB,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,uCAAuC,CAAC,CAAC,CAAC,CAAC;QACrE,eAAe,EAAE,CAAC,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,qDAAqD,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;QAC5G,UAAU,EAAE,CAAC,CAAC,oBAAiD;QAC/D,gBAAgB,EAAE,CAAC,CAAC,sBAAyD;KAChF,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uCAAuC,CAAC,QAAsB;IAC1E,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,6BAA6B,CAAC,UAA0B;IACpE,OAAO;QACH,EAAE,EAAE,UAAU,CAAC,EAAE;QACjB,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,WAAW,EAAE,UAAU,CAAC,WAAW;QACnC,UAAU,EAAE,UAAU,CAAC,UAAU;QACjC,QAAQ,EAAE,UAAU,CAAC,QAAQ;QAC7B,oBAAoB,EAAE,UAAU,CAAC,UAAU;QAC3C,sBAAsB,EAAE,UAAU,CAAC,gBAAgB;KACtD,CAAC;AACN,CAAC;AAED,+EAA+E;AAC/E,sDAAsD;AACtD,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,UAAU,uCAAuC,CAAC,CAAkB;IACtE,OAAO;QACH,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,YAAY,EAAE,CAAC,CAAC,YAAY;QAC5B,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,SAAS,EAAE,CAAC,CAAC,SAAS;QACtB,KAAK,EAAE,CAAC,CAAC,KAAK;QACd,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,UAAU,EAAE,CAAC,CAAC,UAAU;QACxB,YAAY,EAAE,CAAC,CAAC,YAAY;QAC5B,aAAa,EAAE,CAAC,CAAC,aAAa;QAC9B,aAAa,EAAE,CAAC,CAAC,aAAa;QAC9B,YAAY,EAAE,CAAC,CAAC,YAAY;QAC5B,aAAa,EAAE,CAAC,CAAC,aAAa;QAC9B,kBAAkB,EAAE,CAAC,CAAC,kBAAkB;QACxC,SAAS,EAAE,CAAC,CAAC,SAAS;QACtB,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,eAAe,EAAE,CAAC,CAAC,eAAe;QAClC,sBAAsB,EAAE,CAAC,CAAC,sBAAsB;QAChD,aAAa,EAAE,CAAC,CAAC,aAAa;QAC9B,uBAAuB,EAAE,CAAC,CAAC,uBAAuB;QAClD,qBAAqB,EAAE,CAAC,CAAC,qBAAqB;QAC9C,cAAc,EAAE,CAAC,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAC3C,KAAK,EAAE,CAAC,CAAC,KAAK;YACd,YAAY,EAAE,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;SACxD,CAAC,CAAC;KACN,CAAC;AACN,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,uCAAuC,CAAC,SAA8B;IAClF,OAAO;QACH,QAAQ,EAAE,SAAS,CAAC,QAAQ;QAC5B,QAAQ,EAAE,SAAS,CAAC,QAAQ;QAC5B,IAAI,EAAE,SAAS,CAAC,IAAI;QACpB,WAAW,EAAE,SAAS,CAAC,WAAW;QAClC,WAAW,EAAE,SAAS,CAAC,WAAW;QAClC,YAAY,EAAE,SAAS,CAAC,YAAY;QACpC,QAAQ,EAAE,SAAS,CAAC,QAAQ;QAC5B,QAAQ,EAAE,SAAS,CAAC,QAAQ;QAC5B,IAAI,EAAE,SAAS,CAAC,IAAI;QACpB,MAAM,EAAE,SAAS,CAAC,MAAM;QACxB,SAAS,EAAE,SAAS,CAAC,SAAS;QAC9B,KAAK,EAAE,SAAS,CAAC,KAAK;QACtB,UAAU,EAAE,SAAS,CAAC,UAAU;QAChC,YAAY,EAAE,SAAS,CAAC,YAAY;QACpC,aAAa,EAAE,SAAS,CAAC,aAAa;QACtC,aAAa,EAAE,SAAS,CAAC,aAAa;QACtC,YAAY,EAAE,SAAS,CAAC,YAAY;QACpC,aAAa,EAAE,SAAS,CAAC,aAAa;QACtC,kBAAkB,EAAE,SAAS,CAAC,kBAAkB;QAChD,SAAS,EAAE,SAAS,CAAC,SAAS;QAC9B,WAAW,EAAE,SAAS,CAAC,WAAW;QAClC,eAAe,EAAE,SAAS,CAAC,eAAe;QAC1C,sBAAsB,EAAE,SAAS,CAAC,sBAAsB;KAC3D,CAAC;AACN,CAAC;AAED,+EAA+E;AAC/E,gEAAgE;AAChE,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,UAAU,iDAAiD,CAAC,EAAwB;IACtF,OAAO;QACH,KAAK,EAAE,EAAE,CAAC,KAAK;QACf,YAAY,EAAE,EAAE,CAAC,KAAK;KACzB,CAAC;AACN,CAAC;AAED,+EAA+E;AAC/E,oEAAoE;AACpE,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,UAAU,qDAAqD,CAAC,EAA0B;IAC5F,OAAO;QACH,QAAQ,EAAE,EAAE,CAAC,QAAQ;QACrB,MAAM,EAAE,EAAE,CAAC,MAAM;QACjB,cAAc,EAAE,EAAE,CAAC,cAAc;QACjC,cAAc,EAAE,EAAE,CAAC,cAAc;QACjC,eAAe,EAAE,EAAE,CAAC,eAAe;QACnC,sBAAsB,EAAE,EAAE,CAAC,sBAAsB;QACjD,qBAAqB,EAAE,EAAE,CAAC,qBAAqB;QAC/C,aAAa,EAAE,EAAE,CAAC,aAAa;QAC/B,IAAI,EAAE,EAAE,CAAC,IAAI;QACb,0BAA0B,EAAE,EAAE,CAAC,0BAA0B;QACzD,QAAQ,EAAE,EAAE,CAAC,QAAQ;QACrB,mBAAmB,EAAE,EAAE,CAAC,mBAAmB;KAC9C,CAAC;AACN,CAAC;AAED,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAE/E;;;;;GAKG;AACH,MAAM,UAAU,mCAAmC,CAAC,YAA8B;IAC9E,OAAO;QACH,EAAE,EAAE,EAAE;QACN,IAAI,EAAE,YAAY,CAAC,IAAI;QACvB,WAAW,EAAE,YAAY,CAAC,WAAW;QACrC,UAAU,EAAE,EAAE;QACd,QAAQ,EAAE,EAAE;QACZ,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,6CAA6C,CAAC,CAAC,CAAC,CAAC;QACtF,eAAe,EAAE,EAAE;KACtB,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,6CAA6C,CAAC,QAA4B;IACtF,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,mCAAmC,CAAC,CAAC,CAAC,CAAC,CAAC;AACrE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mCAAmC,CAAC,UAA0B;IAC1E,OAAO,IAAI,gBAAgB,CAAC;QACxB,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,WAAW,EAAE,UAAU,CAAC,WAAW;QACnC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,6CAA6C,CAAC,CAAC,CAAC,CAAC;KACvF,CAAC,CAAC;AACP,CAAC;AAED,+EAA+E;AAC/E,4DAA4D;AAC5D,+EAA+E;AAE/E;;;;;GAKG;AACH,MAAM,UAAU,6CAA6C,CAAC,WAAkC;IAC5F,OAAO;QACH,QAAQ,EAAE,EAAE;QACZ,QAAQ,EAAE,WAAW,CAAC,QAAQ;QAC9B,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,WAAW,EAAE,SAAS;QACtB,WAAW,EAAE,WAAW,CAAC,WAAW;QACpC,YAAY,EAAE,WAAW,CAAC,YAAY;QACtC,QAAQ,EAAE,KAAK;QACf,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,MAAM,EAAE,CAAC;QACT,SAAS,EAAE,CAAC;QACZ,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,EAAE;QACf,UAAU,EAAE,WAAW,CAAC,UAAU;QAClC,YAAY,EAAE,EAAE;QAChB,aAAa,EAAE,KAAK;QACpB,aAAa,EAAE,SAAS;QACxB,YAAY,EAAE,SAAS;QACvB,aAAa,EAAE,WAAW,CAAC,aAAa;QACxC,kBAAkB,EAAE,CAAC;QACrB,SAAS,EAAE,KAAK;QAChB,WAAW,EAAE,KAAK;QAClB,eAAe,EAAE,SAAS;QAC1B,sBAAsB,EAAE,SAAS;QACjC,aAAa,EAAE,SAAS;QACxB,uBAAuB,EAAE,SAAS;QAClC,qBAAqB,EAAE,SAAS;QAChC,cAAc,EAAE,WAAW,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;KACvE,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,6CAA6C,CAAC,SAA8B;IACxF,OAAO,IAAI,qBAAqB,CAAC;QAC7B,IAAI,EAAE,SAAS,CAAC,IAAI;QACpB,QAAQ,EAAE,SAAS,CAAC,QAAQ;QAC5B,aAAa,EAAE,SAAS,CAAC,aAAa;QACtC,IAAI,EAAE,SAAS,CAAC,IAAI;QACpB,UAAU,EAAE,SAAS,CAAC,UAAU;QAChC,YAAY,EAAE,SAAS,CAAC,YAAY;QACpC,WAAW,EAAE,SAAS,CAAC,WAAW;QAClC,cAAc,EAAE,SAAS,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;KAC9D,CAAC,CAAC;AACP,CAAC;AAED,+EAA+E;AAC/E,mDAAmD;AACnD,+EAA+E;AAE/E;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAsB,EAAE,SAAiB;IACxE,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;AACzD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAsB,EAAE,SAAiB;IACxE,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;AACzD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CAAC,MAAsB;IAC5D,OAAO,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AACnD,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@memberjunction/skip-types",
|
|
3
|
-
"
|
|
3
|
+
"type": "module",
|
|
4
|
+
"version": "4.1.0",
|
|
4
5
|
"description": "MemberJunction: Skip AI Assistant - Types that are used between the MJAPI and the Skip API as well as the UI within MemberJunction Explorer",
|
|
5
6
|
"main": "dist/index.js",
|
|
6
7
|
"types": "dist/index.d.ts",
|
|
@@ -9,20 +10,20 @@
|
|
|
9
10
|
],
|
|
10
11
|
"scripts": {
|
|
11
12
|
"start": "ts-node-dev src/index.ts",
|
|
12
|
-
"build": "tsc",
|
|
13
|
+
"build": "tsc && tsc-alias -f",
|
|
13
14
|
"test": "echo \"Error: no test specified\" && exit 1"
|
|
14
15
|
},
|
|
15
16
|
"author": "MemberJunction.com",
|
|
16
17
|
"license": "ISC",
|
|
17
18
|
"devDependencies": {
|
|
18
19
|
"ts-node-dev": "^2.0.0",
|
|
19
|
-
"typescript": "^5.
|
|
20
|
+
"typescript": "^5.9.3"
|
|
20
21
|
},
|
|
21
22
|
"dependencies": {
|
|
22
|
-
"@memberjunction/core": "
|
|
23
|
-
"@memberjunction/interactive-component-types": "
|
|
24
|
-
"@memberjunction/ai-core-plus": "
|
|
25
|
-
"@memberjunction/data-context": "
|
|
23
|
+
"@memberjunction/core": "4.1.0",
|
|
24
|
+
"@memberjunction/interactive-component-types": "4.1.0",
|
|
25
|
+
"@memberjunction/ai-core-plus": "4.1.0",
|
|
26
|
+
"@memberjunction/data-context": "4.1.0"
|
|
26
27
|
},
|
|
27
28
|
"repository": {
|
|
28
29
|
"type": "git",
|
package/readme.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @memberjunction/skip-types
|
|
2
2
|
|
|
3
3
|
Type definitions and interfaces for the Skip AI Assistant integration with MemberJunction. This package provides the contract between the MemberJunction API, Skip API, and the MemberJunction Explorer UI.
|
|
4
4
|
|
|
@@ -6,6 +6,27 @@ Type definitions and interfaces for the Skip AI Assistant integration with Membe
|
|
|
6
6
|
|
|
7
7
|
The `@memberjunction/skip-types` package contains TypeScript type definitions, interfaces, and enums that facilitate communication between different components of the MemberJunction Skip AI assistant system. It ensures type safety and consistent data structures when interacting with the Skip API or rendering Skip-generated content in MemberJunction applications.
|
|
8
8
|
|
|
9
|
+
```mermaid
|
|
10
|
+
graph LR
|
|
11
|
+
A["MJ Explorer UI"] -->|"SkipAPIRequest"| B["MJAPI Server"]
|
|
12
|
+
B -->|"SkipAPIRequest"| C["Skip API"]
|
|
13
|
+
C -->|"SkipAPIResponse"| B
|
|
14
|
+
B -->|"MJAPISkipResult"| A
|
|
15
|
+
|
|
16
|
+
C --> D["SkipMessage<br/>SkipConversation"]
|
|
17
|
+
C --> E["SkipComponent<br/>SkipComponentCallbacks"]
|
|
18
|
+
C --> F["SkipDataRequest<br/>SkipEntityInfo"]
|
|
19
|
+
C --> G["Learning Cycle<br/>Types"]
|
|
20
|
+
|
|
21
|
+
style A fill:#2d6a9f,stroke:#1a4971,color:#fff
|
|
22
|
+
style B fill:#7c5295,stroke:#563a6b,color:#fff
|
|
23
|
+
style C fill:#2d8659,stroke:#1a5c3a,color:#fff
|
|
24
|
+
style D fill:#b8762f,stroke:#8a5722,color:#fff
|
|
25
|
+
style E fill:#b8762f,stroke:#8a5722,color:#fff
|
|
26
|
+
style F fill:#b8762f,stroke:#8a5722,color:#fff
|
|
27
|
+
style G fill:#b8762f,stroke:#8a5722,color:#fff
|
|
28
|
+
```
|
|
29
|
+
|
|
9
30
|
## Installation
|
|
10
31
|
|
|
11
32
|
```bash
|