@memberjunction/skip-types 0.9.2

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

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

package/dist/types.d.ts

@@ -0,0 +1,93 @@
+import { UserViewEntityExtended } from '@memberjunction/core-entities';
+export declare class SubProcessResponse {
+    status: "success" | "error";
+    resultType: "data" | "plot" | "html" | null;
+    tableData: any[] | null;
+    plotData: {
+        data: any[];
+        layout: any;
+    } | null;
+    htmlReport: string | null;
+    analysis: string | null;
+    errorMessage: string | null;
+}
+/**
+ * Defines the shape of the data that is expected by the Skip API Server when making a request
+ */
+export declare class SkipAPIRequest {
+    /**
+     * The user's input
+     */
+    userInput: string;
+    /**
+     * The data context, use this to provide all of the data you have in a data context to Skip. You should provide this from cache or refreshed based on the parameters provided by the user.
+     */
+    dataContext: SkipDataContext;
+    /**
+     * The conversation ID
+     */
+    conversationID: string;
+    /**
+     * The organization ID - this is part of the Skip API Authentication Request, along with the bearer token in the header (the bearer token is not yet implemented, To-Do!)
+     */
+    organizationID: number;
+    /**
+     * The phase of the conversation, defined as follows:
+     * * initial_request: The initial request from the user - when a new conversation gets started or after a report is created, pass in this value
+     * * clarify_question_response: Sometimes the Skip API server responds back to your request with a responsePhase of 'clarifying_question' - in this situation, the MJAPI server needs to communicate with the UI to ask the follow up question to the user. When you have that feedback from the user gathered and are providing the response to the clarifying question back to Skip API, use this requestPhase
+     * * data_gathering_response: Sometimes the Skip API server responds back to your request with a responsePhase of 'data_request' - in this situation, the MJAPI server needs to process the data request, gather whatever additional data the Skip API has asked for, and then return it in the dataContext property of the SkipAPIRequest object. When you are finished gathering data and returning it to the Skip API server, use this requestPhase
+     */
+    requestPhase: 'initial_request' | 'clarify_question_response' | 'data_gathering_response';
+}
+/**
+ * Defines the shape of the data that is returned by the Skip API Server
+ */
+export declare class SkipAPIResponse {
+    success: boolean;
+    executionResults: SubProcessResponse | null;
+    userExplanation: string;
+    techExplanation: string;
+    suggestedQuestions: string[] | null;
+    reportTitle: string | null;
+    analysis: string | null;
+    scriptText: string | null;
+    responsePhase: "clarifying_question" | "data_request" | "analysis_complete";
+}
+export declare class SkipDataContextFieldInfo {
+    Name: string;
+    Type: string;
+    Description?: string;
+}
+export declare class SkipDataContextItem {
+    Type: 'view' | 'query' | 'full_entity';
+    /**
+     * The ID of the view, query, or entity in the system
+     */
+    RecordID: number;
+    /**
+     * The name of the view, query, or entity in the system
+     */
+    RecordName: string;
+    /**
+     * The name of the entity in the system, only used if type = 'full_entity' or type = 'view' --- for type of 'query' this is not used as query can come from any number of entities in combination
+     */
+    EntityName?: string;
+    Fields: SkipDataContextFieldInfo[];
+    /**
+     * Generated description of the item  which is dependent on the type of the item
+     */
+    get Description(): string;
+    /**
+     * Populate the SkipDataContextItem from a UserViewEntity class instance
+     * @param viewEntity
+     */
+    static FromViewEntity(viewEntity: UserViewEntityExtended): SkipDataContextItem;
+    Data?: any[];
+    ValidateDataExists(): boolean;
+}
+export declare class SkipDataContext {
+    Items: SkipDataContextItem[];
+    ValidateDataExists(): boolean;
+    ConvertToSimpleObject(): any;
+    CreateSimpleObjectTypeDefinition(): string;
+}

package/dist/types.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SkipDataContext = exports.SkipDataContextItem = exports.SkipDataContextFieldInfo = exports.SkipAPIResponse = exports.SkipAPIRequest = exports.SubProcessResponse = void 0;
+class SubProcessResponse {
+}
+exports.SubProcessResponse = SubProcessResponse;
+/**
+ * Defines the shape of the data that is expected by the Skip API Server when making a request
+ */
+class SkipAPIRequest {
+}
+exports.SkipAPIRequest = SkipAPIRequest;
+/**
+ * Defines the shape of the data that is returned by the Skip API Server
+ */
+class SkipAPIResponse {
+}
+exports.SkipAPIResponse = SkipAPIResponse;
+class SkipDataContextFieldInfo {
+}
+exports.SkipDataContextFieldInfo = SkipDataContextFieldInfo;
+class SkipDataContextItem {
+    constructor() {
+        /*
+        * The fields in the view, query, or entity
+        */
+        this.Fields = [];
+    }
+    /**
+     * Generated description of the item  which is dependent on the type of the item
+     */
+    get Description() {
+        switch (this.Type) {
+            case 'view':
+                return `View: ${this.RecordName}, From Entity: ${this.EntityName}`;
+            case 'query':
+                return `Query: ${this.RecordName}`;
+            case 'full_entity':
+                return `Full Entity - All Records: ${this.EntityName}`;
+            default:
+                return `Unknown Type: ${this.Type}`;
+        }
+    }
+    /**
+     * Populate the SkipDataContextItem from a UserViewEntity class instance
+     * @param viewEntity
+     */
+    static FromViewEntity(viewEntity) {
+        const instance = new SkipDataContextItem();
+        // update our data from the viewEntity definition
+        instance.Type = 'view';
+        instance.EntityName = viewEntity.ViewEntityInfo.Name;
+        instance.RecordID = viewEntity.ID;
+        instance.RecordName = viewEntity.Name;
+        instance.Fields = viewEntity.ViewEntityInfo.Fields.map(f => {
+            return {
+                Name: f.Name,
+                Type: f.Type,
+                Description: f.Description
+            };
+        });
+        return instance;
+    }
+    ValidateDataExists() {
+        return this.Data ? this.Data.length > 0 : false;
+    }
+}
+exports.SkipDataContextItem = SkipDataContextItem;
+class SkipDataContext {
+    constructor() {
+        this.Items = [];
+    }
+    ValidateDataExists() {
+        if (this.Items)
+            return !this.Items.some(i => !i.ValidateDataExists()); // if any data item is invalid, return false
+        else
+            return false;
+    }
+    ConvertToSimpleObject() {
+        // Return a simple object that will have a property for each item in our Items array. We will name each item sequentially as data_item_1, data_item_2, etc.
+        const ret = {};
+        for (let i = 0; i < this.Items.length; i++) {
+            ret[`data_item_${i}`] = this.Items[i].Data;
+        }
+        return ret;
+    }
+    CreateSimpleObjectTypeDefinition() {
+        let sOutput = "";
+        for (let i = 0; i < this.Items.length; i++) {
+            sOutput += `data_item_${i}: []; // array of data items\n`;
+        }
+        return `{${sOutput}}`;
+    }
+}
+exports.SkipDataContext = SkipDataContext;
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAEA,MAAa,kBAAkB;CAQ9B;AARD,gDAQC;AAED;;GAEG;AACH,MAAa,cAAc;CAyB1B;AAzBD,wCAyBC;AAED;;GAEG;AACH,MAAa,eAAe;CAU3B;AAVD,0CAUC;AAGD,MAAa,wBAAwB;CAIpC;AAJD,4DAIC;AAED,MAAa,mBAAmB;IAAhC;QAeI;;UAEE;QACF,WAAM,GAA+B,EAAE,CAAC;IA4C5C,CAAC;IA1CG;;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,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;IAIM,kBAAkB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACpD,CAAC;CACJ;AA9DD,kDA8DC;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

@@ -0,0 +1,24 @@
+{
+  "name": "@memberjunction/skip-types",
+  "version": "0.9.2",
+  "description": "MemberJunction: Skip AI Assistant - Types that are used between the MJAPI and the Skip API as well as the UI within MemberJunction Explorer",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "start": "ts-node-dev src/index.ts",
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "MemberJunction.com",
+  "license": "ISC",
+  "devDependencies": {
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "@memberjunction/core-entities": "^0.9.119"
+  }
+}

package/readme.md

@@ -0,0 +1,18 @@
+```markdown
+# @memberjunction/skip-types
+
+This library provides a set of types that are used to create consistency and coding simplicity for data interchange between the UI, Skip API and MJAPI
+
+## Installation
+
+```bash
+npm install @memberjunction/skip-types
+```
+
+## Contributing
+
+Feel free to open issues or pull requests if you have suggestions or fixes.
+
+## License
+
+MIT License