@memberjunction/skip-types 0.9.5 → 0.9.7
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/types.d.ts +24 -0
- package/dist/types.js +9 -1
- package/dist/types.js.map +1 -1
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { EntityInfo } from '@memberjunction/core';
|
|
1
2
|
import { UserViewEntityExtended } from '@memberjunction/core-entities';
|
|
2
3
|
export declare class SubProcessResponse {
|
|
3
4
|
status: "success" | "error";
|
|
@@ -69,6 +70,19 @@ export declare class SkipAPIResponse {
|
|
|
69
70
|
scriptText: string | null;
|
|
70
71
|
responsePhase: "clarifying_question" | "data_request" | "analysis_complete";
|
|
71
72
|
}
|
|
73
|
+
/**
|
|
74
|
+
* This type is used to define the requested data whenever the Skip API server asks for additional data to be gathered
|
|
75
|
+
*/
|
|
76
|
+
export declare class SkipDataRequest {
|
|
77
|
+
/**
|
|
78
|
+
* The type of request, either "sql" or "stored_query". Stored query refers to the name of a query that is stored in the system and can be executed to gather data. SQL refers to a fully executable SQL statement that can be executed to gather data.
|
|
79
|
+
*/
|
|
80
|
+
requestType: "sql" | "stored_query";
|
|
81
|
+
/**
|
|
82
|
+
* The text of the request - either a fully executable SQL statement or the name of a stored query
|
|
83
|
+
*/
|
|
84
|
+
requestText: string;
|
|
85
|
+
}
|
|
72
86
|
export declare class SkipDataContextFieldInfo {
|
|
73
87
|
Name: string;
|
|
74
88
|
Type: string;
|
|
@@ -89,6 +103,16 @@ export declare class SkipDataContextItem {
|
|
|
89
103
|
*/
|
|
90
104
|
EntityName?: string;
|
|
91
105
|
Fields: SkipDataContextFieldInfo[];
|
|
106
|
+
/**
|
|
107
|
+
* ViewEntity - the object instantiated that contains the metadata for the UserView being used - only populated if the type is 'view', also this is NOT to be sent to/from the API server, it is a placeholder that can be used
|
|
108
|
+
* within a given tier like in the MJAPI server or Skip Server or in the UI.
|
|
109
|
+
*/
|
|
110
|
+
ViewEntity?: UserViewEntityExtended;
|
|
111
|
+
/**
|
|
112
|
+
* Entity - the object that contains metadata for the entity being used, only populated if the type is 'full_entity' or 'view' - also this is NOT to be sent to/from the API server, it is a placeholder that can be used
|
|
113
|
+
* within a given tier like in the MJAPI server or Skip Server or in the UI.
|
|
114
|
+
*/
|
|
115
|
+
Entity?: EntityInfo;
|
|
92
116
|
/**
|
|
93
117
|
* Generated description of the item which is dependent on the type of the item
|
|
94
118
|
*/
|
package/dist/types.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.SkipDataContext = exports.SkipDataContextItem = exports.SkipDataContextFieldInfo = exports.SkipAPIResponse = exports.SkipAPIRequest = exports.SkipMessage = exports.SubProcessResponse = void 0;
|
|
3
|
+
exports.SkipDataContext = exports.SkipDataContextItem = exports.SkipDataContextFieldInfo = exports.SkipDataRequest = exports.SkipAPIResponse = exports.SkipAPIRequest = exports.SkipMessage = exports.SubProcessResponse = void 0;
|
|
4
4
|
class SubProcessResponse {
|
|
5
5
|
}
|
|
6
6
|
exports.SubProcessResponse = SubProcessResponse;
|
|
@@ -22,6 +22,12 @@ exports.SkipAPIRequest = SkipAPIRequest;
|
|
|
22
22
|
class SkipAPIResponse {
|
|
23
23
|
}
|
|
24
24
|
exports.SkipAPIResponse = SkipAPIResponse;
|
|
25
|
+
/**
|
|
26
|
+
* This type is used to define the requested data whenever the Skip API server asks for additional data to be gathered
|
|
27
|
+
*/
|
|
28
|
+
class SkipDataRequest {
|
|
29
|
+
}
|
|
30
|
+
exports.SkipDataRequest = SkipDataRequest;
|
|
25
31
|
class SkipDataContextFieldInfo {
|
|
26
32
|
}
|
|
27
33
|
exports.SkipDataContextFieldInfo = SkipDataContextFieldInfo;
|
|
@@ -54,6 +60,8 @@ class SkipDataContextItem {
|
|
|
54
60
|
static FromViewEntity(viewEntity) {
|
|
55
61
|
const instance = new SkipDataContextItem();
|
|
56
62
|
// update our data from the viewEntity definition
|
|
63
|
+
instance.ViewEntity = viewEntity;
|
|
64
|
+
instance.Entity = viewEntity.ViewEntityInfo;
|
|
57
65
|
instance.Type = 'view';
|
|
58
66
|
instance.EntityName = viewEntity.ViewEntityInfo.Name;
|
|
59
67
|
instance.RecordID = viewEntity.ID;
|
package/dist/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAGA,MAAa,kBAAkB;CAQ9B;AARD,gDAQC;AAGD;;GAEG;AACH,MAAa,WAAW;CASvB;AATD,kCASC;AAED;;GAEG;AACH,MAAa,cAAc;CA2B1B;AA3BD,wCA2BC;AAED;;GAEG;AACH,MAAa,eAAe;CAW3B;AAXD,0CAWC;AAED;;GAEG;AACH,MAAa,eAAe;CAS3B;AATD,0CASC;AAED,MAAa,wBAAwB;CAIpC;AAJD,4DAIC;AAED,MAAa,mBAAmB;IAAhC;QAeI;;UAEE;QACF,WAAM,GAA+B,EAAE,CAAC;IA4D5C,CAAC;IA9CG;;OAEG;IACH,IAAI,WAAW;QACX,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAChB,KAAK,MAAM;gBACP,OAAO,SAAS,IAAI,CAAC,UAAU,kBAAkB,IAAI,CAAC,UAAU,EAAE,CAAC;YACvE,KAAK,OAAO;gBACR,OAAO,UAAU,IAAI,CAAC,UAAU,EAAE,CAAC;YACvC,KAAK,aAAa;gBACd,OAAO,8BAA8B,IAAI,CAAC,UAAU,EAAE,CAAC;YAC3D;gBACI,OAAO,iBAAiB,IAAI,CAAC,IAAI,EAAE,CAAC;QAC5C,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,UAAkC;QAC3D,MAAM,QAAQ,GAAG,IAAI,mBAAmB,EAAE,CAAC;QAC3C,iDAAiD;QACjD,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC;QACjC,QAAQ,CAAC,MAAM,GAAG,UAAU,CAAC,cAAc,CAAC;QAC5C,QAAQ,CAAC,IAAI,GAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC;QACrD,QAAQ,CAAC,QAAQ,GAAG,UAAU,CAAC,EAAE,CAAC;QAClC,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC;QACtC,QAAQ,CAAC,MAAM,GAAG,UAAU,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YACvD,OAAO;gBACH,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,WAAW,EAAE,CAAC,CAAC,WAAW;aAC7B,CAAA;QACL,CAAC,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IACpB,CAAC;IAMM,kBAAkB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACpD,CAAC;CACJ;AA9ED,kDA8EC;AAED,MAAa,eAAe;IAA5B;QACI,UAAK,GAA0B,EAAE,CAAC;IAyBtC,CAAC;IAvBU,kBAAkB;QACrB,IAAI,IAAI,CAAC,KAAK;YACV,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC,4CAA4C;;YAEnG,OAAO,KAAK,CAAC;IACrB,CAAC;IAEM,qBAAqB;QACxB,2JAA2J;QAC3J,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACzC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC/C,CAAC;QACD,OAAO,GAAG,CAAC;IACf,CAAC;IAEM,gCAAgC;QACnC,IAAI,OAAO,GAAW,EAAE,CAAC;QACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACzC,OAAO,IAAI,aAAa,CAAC,gCAAgC,CAAC;QAC9D,CAAC;QACD,OAAO,IAAI,OAAO,GAAG,CAAC;IAC1B,CAAC;CACJ;AA1BD,0CA0BC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@memberjunction/skip-types",
|
|
3
|
-
"version": "0.9.
|
|
3
|
+
"version": "0.9.7",
|
|
4
4
|
"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
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|