@memberjunction/skip-types 0.9.8 → 0.9.9
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 +13 -4
- package/dist/types.js +8 -4
- package/dist/types.js.map +1 -1
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -103,11 +103,15 @@ export declare class SkipDataRequest {
|
|
|
103
103
|
/**
|
|
104
104
|
* 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.
|
|
105
105
|
*/
|
|
106
|
-
|
|
106
|
+
type: "sql" | "stored_query";
|
|
107
107
|
/**
|
|
108
108
|
* The text of the request - either a fully executable SQL statement or the name of a stored query
|
|
109
109
|
*/
|
|
110
|
-
|
|
110
|
+
text: string;
|
|
111
|
+
/**
|
|
112
|
+
* A description of the request, why it was requested, and what it is expected to provide
|
|
113
|
+
*/
|
|
114
|
+
description?: string;
|
|
111
115
|
}
|
|
112
116
|
export declare class SkipDataContextFieldInfo {
|
|
113
117
|
Name: string;
|
|
@@ -115,13 +119,16 @@ export declare class SkipDataContextFieldInfo {
|
|
|
115
119
|
Description?: string;
|
|
116
120
|
}
|
|
117
121
|
export declare class SkipDataContextItem {
|
|
118
|
-
|
|
122
|
+
/**
|
|
123
|
+
* The type of the item, either "view", "query", "full_entity", or "sql"
|
|
124
|
+
*/
|
|
125
|
+
Type: 'view' | 'query' | 'full_entity' | 'sql';
|
|
119
126
|
/**
|
|
120
127
|
* The ID of the view, query, or entity in the system
|
|
121
128
|
*/
|
|
122
129
|
RecordID: number;
|
|
123
130
|
/**
|
|
124
|
-
* The name of the view, query, or entity in the system
|
|
131
|
+
* The name of the view, query, or entity in the system. If Type = sql, this is the full SQL statement
|
|
125
132
|
*/
|
|
126
133
|
RecordName: string;
|
|
127
134
|
/**
|
|
@@ -139,6 +146,8 @@ export declare class SkipDataContextItem {
|
|
|
139
146
|
* within a given tier like in the MJAPI server or Skip Server or in the UI.
|
|
140
147
|
*/
|
|
141
148
|
Entity?: EntityInfo;
|
|
149
|
+
/** Additional Description has any other information that might be useful for someone (or an LLM) intepreting the contents of this data item */
|
|
150
|
+
AdditionalDescription?: string;
|
|
142
151
|
/**
|
|
143
152
|
* Generated description of the item which is dependent on the type of the item
|
|
144
153
|
*/
|
package/dist/types.js
CHANGED
|
@@ -60,16 +60,20 @@ class SkipDataContextItem {
|
|
|
60
60
|
* Generated description of the item which is dependent on the type of the item
|
|
61
61
|
*/
|
|
62
62
|
get Description() {
|
|
63
|
+
let ret = '';
|
|
63
64
|
switch (this.Type) {
|
|
64
65
|
case 'view':
|
|
65
|
-
|
|
66
|
+
ret = `View: ${this.RecordName}, From Entity: ${this.EntityName}`;
|
|
66
67
|
case 'query':
|
|
67
|
-
|
|
68
|
+
ret = `Query: ${this.RecordName}`;
|
|
68
69
|
case 'full_entity':
|
|
69
|
-
|
|
70
|
+
ret = `Full Entity - All Records: ${this.EntityName}`;
|
|
70
71
|
default:
|
|
71
|
-
|
|
72
|
+
ret = `Unknown Type: ${this.Type}`;
|
|
72
73
|
}
|
|
74
|
+
if (this.AdditionalDescription && this.AdditionalDescription.length > 0)
|
|
75
|
+
ret += ` (More Info: ${this.AdditionalDescription})`;
|
|
76
|
+
return ret;
|
|
73
77
|
}
|
|
74
78
|
/**
|
|
75
79
|
* Populate the SkipDataContextItem from a UserViewEntity class instance
|
package/dist/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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;CAa3B;AAbD,0CAaC;AAED;;GAEG;AACH,MAAa,+BAAgC,SAAQ,eAAe;CAQnE;AARD,0EAQC;AAED;;GAEG;AACH,MAAa,iCAAkC,SAAQ,eAAe;CAErE;AAFD,8EAEC;AAED;;GAEG;AACH,MAAa,0BAA2B,SAAQ,eAAe;CAE9D;AAFD,gEAEC;AAED;;GAEG;AACH,MAAa,eAAe;
|
|
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;CAa3B;AAbD,0CAaC;AAED;;GAEG;AACH,MAAa,+BAAgC,SAAQ,eAAe;CAQnE;AARD,0EAQC;AAED;;GAEG;AACH,MAAa,iCAAkC,SAAQ,eAAe;CAErE;AAFD,8EAEC;AAED;;GAEG;AACH,MAAa,0BAA2B,SAAQ,eAAe;CAE9D;AAFD,gEAEC;AAED;;GAEG;AACH,MAAa,eAAe;CAa3B;AAbD,0CAaC;AAED,MAAa,wBAAwB;CAIpC;AAJD,4DAIC;AAED,MAAa,mBAAmB;IAAhC;QAkBI;;UAEE;QACF,WAAM,GAA+B,EAAE,CAAC;IAmE5C,CAAC;IAlDG;;OAEG;IACH,IAAI,WAAW;QACX,IAAI,GAAG,GAAW,EAAE,CAAC;QACrB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAChB,KAAK,MAAM;gBACP,GAAG,GAAG,SAAS,IAAI,CAAC,UAAU,kBAAkB,IAAI,CAAC,UAAU,EAAE,CAAC;YACtE,KAAK,OAAO;gBACR,GAAG,GAAG,UAAU,IAAI,CAAC,UAAU,EAAE,CAAC;YACtC,KAAK,aAAa;gBACd,GAAG,GAAG,8BAA8B,IAAI,CAAC,UAAU,EAAE,CAAC;YAC1D;gBACI,GAAG,GAAG,iBAAiB,IAAI,CAAC,IAAI,EAAE,CAAC;QAC3C,CAAC;QACD,IAAI,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,GAAG,CAAC;YACnE,GAAG,IAAI,gBAAgB,IAAI,CAAC,qBAAqB,GAAG,CAAC;QACzD,OAAO,GAAG,CAAC;IACf,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;AAxFD,kDAwFC;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.9",
|
|
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",
|