@memberjunction/data-context 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,0CAAuB"}

package/dist/types.d.ts

@@ -0,0 +1,115 @@
+import { BaseEntity, EntityInfo, QueryInfo } from "@memberjunction/core";
+import { UserViewEntityExtended } from "@memberjunction/core-entities";
+export declare class DataContextFieldInfo {
+    Name: string;
+    Type: string;
+    Description?: string;
+}
+export declare class DataContextItem {
+    /**
+     * The type of the item, either "view", "query", "full_entity", or "sql", or "single_record"
+     */
+    Type: 'view' | 'query' | 'full_entity' | 'sql' | 'single_record';
+    /**
+     * The primary key of the single record in the system, only used if type = 'single_record'
+     */
+    RecordID: string;
+    /**
+     * EntityID - the ID of the entity in the system, only used if type = 'full_entity', 'view', or 'single_record' --- for type of 'query' or 'sql' this property is not used as results can come from any number of entities in combination
+     */
+    EntityID?: number;
+    /**
+     * ViewID - the ID of the view in the system, only used if type = 'view'
+     */
+    ViewID?: number;
+    /**
+     * QueryID - the ID of the query in the system, only used if type = 'query'
+     */
+    QueryID?: number;
+    /**
+     * The name of the view, query, or entity in the system. Not used with type='single_record' or type='sql'
+     */
+    RecordName: string;
+    /**
+     * SQL - the SQL statement to execute, only used if type = 'sql'
+     */
+    SQL?: string;
+    /**
+     * The name of the entity in the system, only used if type = 'full_entity', 'view', or 'single_record' --- for type of 'query' or 'sql' this property is not used as results can come from any number of entities in combination
+     */
+    EntityName?: string;
+    Fields: DataContextFieldInfo[];
+    /**
+     * This field can be used at run time to stash the record ID in the database of the Data Context Item, if it was already saved. For items that haven't/won't be saved, this property can be ignored.
+     */
+    DataContextItemID?: number;
+    /**
+     * 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
+     *              within a given tier like in the MJAPI server or in the UI.
+     */
+    ViewEntity?: UserViewEntityExtended;
+    /**
+     * SingleRecord - the object instantiated that contains the data for the single record being used - only populated if the type is 'single_record' - also this is NOT to be sent to/from the API server, it is a placeholder that can be used in a given tier
+     */
+    SingleRecord?: BaseEntity;
+    /**
+     * 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
+     *          within a given tier like in the MJAPI server or in the UI.
+     */
+    Entity?: EntityInfo;
+    /** Additional Description has any other information that might be useful for someone (or an LLM) intepreting the contents of this data item */
+    AdditionalDescription?: string;
+    /**
+     * Generated description of the item  which is dependent on the type of the item
+     */
+    get Description(): string;
+    /**
+     * Create a new DataContextItem from a UserViewEntity class instance
+     * @param viewEntity
+     */
+    static FromViewEntity(viewEntity: UserViewEntityExtended): DataContextItem;
+    /**
+     * Create a new DataContextItem from a BaseEntity class instance
+     * @param singleRecord
+     * @returns
+     */
+    static FromSingleRecord(singleRecord: BaseEntity): DataContextItem;
+    /**
+     * Create a new DataContextItem from a QueryInfo class instance
+     * @param query
+     * @returns
+     */
+    static FromQuery(query: QueryInfo): DataContextItem;
+    /**
+     * Create a new DataContextItem from a EntityInfo class instance
+     * @param entity
+     * @returns
+     */
+    static FromFullEntity(entity: EntityInfo): DataContextItem;
+    Data?: any[];
+    /**
+     * Validates that the Data property is set. Valid states include a zero length array, or an array with one or more elements. If the Data property is not set, this method will return false
+     * @returns
+     */
+    ValidateDataExists(): boolean;
+}
+export declare class DataContext {
+    Items: DataContextItem[];
+    /**
+     * Simple validation method that determines if all of the items in the data context have data set. This doesn't mean the items have data in them as zero-length data is consider valid, it is checking to see if the Data property is set on each item or not
+     * @returns
+     */
+    ValidateDataExists(): boolean;
+    /**
+     * 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, using the itemPrefix parameter
+     * @param itemPrefix defaults to 'data_item_' and can be set to anything desired
+     * @returns
+     */
+    ConvertToSimpleObject(itemPrefix?: string): any;
+    /**
+     * Return a string that contains a type definition for a simple object for this data context. The object 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, using the itemPrefix parameter
+     * @param itemPrefix defaults to 'data_item_' and can be set to anything desired
+     * @returns
+     */
+    CreateSimpleObjectTypeDefinition(itemPrefix?: string): string;
+}

package/dist/types.js

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataContext = exports.DataContextItem = exports.DataContextFieldInfo = void 0;
+class DataContextFieldInfo {
+}
+exports.DataContextFieldInfo = DataContextFieldInfo;
+class DataContextItem {
+    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() {
+        let ret = '';
+        switch (this.Type) {
+            case 'view':
+                ret = `View: ${this.RecordName}, From Entity: ${this.EntityName}`;
+                break;
+            case 'query':
+                ret = `Query: ${this.RecordName}`;
+                break;
+            case 'full_entity':
+                ret = `Full Entity - All Records: ${this.EntityName}`;
+                break;
+            case 'sql':
+                ret = `SQL Statement: ${this.RecordName}`;
+                break;
+            default:
+                ret = `Unknown Type: ${this.Type}`;
+                break;
+        }
+        if (this.AdditionalDescription && this.AdditionalDescription.length > 0)
+            ret += ` (More Info: ${this.AdditionalDescription})`;
+        return ret;
+    }
+    /**
+     * Create a new DataContextItem from a UserViewEntity class instance
+     * @param viewEntity
+     */
+    static FromViewEntity(viewEntity) {
+        const instance = new DataContextItem();
+        // update our data from the viewEntity definition
+        instance.Type = 'view';
+        instance.ViewEntity = viewEntity;
+        instance.Entity = viewEntity.ViewEntityInfo;
+        instance.EntityName = viewEntity.ViewEntityInfo.Name;
+        instance.ViewID = 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;
+    }
+    /**
+     * Create a new DataContextItem from a BaseEntity class instance
+     * @param singleRecord
+     * @returns
+     */
+    static FromSingleRecord(singleRecord) {
+        const instance = new DataContextItem();
+        instance.Type = 'single_record';
+        instance.RecordID = singleRecord.PrimaryKey.Value;
+        instance.EntityID = singleRecord.EntityInfo.ID;
+        instance.EntityName = singleRecord.EntityInfo.Name;
+        instance.SingleRecord = singleRecord;
+        return instance;
+    }
+    /**
+     * Create a new DataContextItem from a QueryInfo class instance
+     * @param query
+     * @returns
+     */
+    static FromQuery(query) {
+        const instance = new DataContextItem();
+        instance.Type = 'query';
+        instance.QueryID = query.ID;
+        instance.RecordName = query.Name;
+        instance.Fields = query.Fields.map(f => {
+            return {
+                Name: f.Name,
+                Type: f.SQLBaseType,
+                Description: f.Description
+            };
+        });
+        return instance;
+    }
+    /**
+     * Create a new DataContextItem from a EntityInfo class instance
+     * @param entity
+     * @returns
+     */
+    static FromFullEntity(entity) {
+        const instance = new DataContextItem();
+        instance.Type = 'full_entity';
+        instance.EntityID = entity.ID;
+        instance.EntityName = entity.Name;
+        instance.Entity = entity;
+        instance.RecordName = entity.Name;
+        instance.Fields = entity.Fields.map(f => {
+            return {
+                Name: f.Name,
+                Type: f.Type,
+                Description: f.Description
+            };
+        });
+        return instance;
+    }
+    /**
+     * Validates that the Data property is set. Valid states include a zero length array, or an array with one or more elements. If the Data property is not set, this method will return false
+     * @returns
+     */
+    ValidateDataExists() {
+        return this.Data ? this.Data.length >= 0 : false; // can have 0 to many rows, just need to make sure we have a Data object to work with
+    }
+}
+exports.DataContextItem = DataContextItem;
+class DataContext {
+    constructor() {
+        this.Items = [];
+    }
+    /**
+     * Simple validation method that determines if all of the items in the data context have data set. This doesn't mean the items have data in them as zero-length data is consider valid, it is checking to see if the Data property is set on each item or not
+     * @returns
+     */
+    ValidateDataExists() {
+        if (this.Items)
+            return !this.Items.some(i => !i.ValidateDataExists()); // if any data item is invalid, return false
+        else
+            return false;
+    }
+    /**
+     * 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, using the itemPrefix parameter
+     * @param itemPrefix defaults to 'data_item_' and can be set to anything desired
+     * @returns
+     */
+    ConvertToSimpleObject(itemPrefix = 'data_item_') {
+        // 
+        const ret = {};
+        for (let i = 0; i < this.Items.length; i++) {
+            ret[`${itemPrefix}${i}`] = this.Items[i].Data;
+        }
+        return ret;
+    }
+    /**
+     * Return a string that contains a type definition for a simple object for this data context. The object 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, using the itemPrefix parameter
+     * @param itemPrefix defaults to 'data_item_' and can be set to anything desired
+     * @returns
+     */
+    CreateSimpleObjectTypeDefinition(itemPrefix = 'data_item_') {
+        let sOutput = "";
+        for (let i = 0; i < this.Items.length; i++) {
+            const item = this.Items[i];
+            sOutput += `${itemPrefix}${i}: []; // ${item.Description}\n`;
+        }
+        return `{${sOutput}}`;
+    }
+}
+exports.DataContext = DataContext;
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAGA,MAAa,oBAAoB;CAIhC;AAJD,oDAIC;AAED,MAAa,eAAe;IAA5B;QAyCI;;UAEE;QACF,WAAM,GAA2B,EAAE,CAAC;IAiJxC,CAAC;IAtHG;;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;gBAClE,MAAM;YACV,KAAK,OAAO;gBACR,GAAG,GAAG,UAAU,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClC,MAAM;YACV,KAAK,aAAa;gBACd,GAAG,GAAG,8BAA8B,IAAI,CAAC,UAAU,EAAE,CAAC;gBACtD,MAAM;YACV,KAAK,KAAK;gBACN,GAAG,GAAG,kBAAkB,IAAI,CAAC,UAAU,EAAE,CAAC;gBAC1C,MAAM;YACV;gBACI,GAAG,GAAG,iBAAiB,IAAI,CAAC,IAAI,EAAE,CAAC;gBACnC,MAAM;QACd,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,eAAe,EAAE,CAAC;QACvC,iDAAiD;QACjD,QAAQ,CAAC,IAAI,GAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC;QACjC,QAAQ,CAAC,MAAM,GAAG,UAAU,CAAC,cAAc,CAAC;QAC5C,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC;QACrD,QAAQ,CAAC,MAAM,GAAG,UAAU,CAAC,EAAE,CAAC;QAChC,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;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,YAAwB;QACnD,MAAM,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;QACvC,QAAQ,CAAC,IAAI,GAAG,eAAe,CAAC;QAChC,QAAQ,CAAC,QAAQ,GAAG,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC;QAClD,QAAQ,CAAC,QAAQ,GAAG,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/C,QAAQ,CAAC,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC;QACnD,QAAQ,CAAC,YAAY,GAAG,YAAY,CAAC;QACrC,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,SAAS,CAAC,KAAgB;QACpC,MAAM,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;QACvC,QAAQ,CAAC,IAAI,GAAG,OAAO,CAAC;QACxB,QAAQ,CAAC,OAAO,GAAG,KAAK,CAAC,EAAE,CAAC;QAC5B,QAAQ,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC;QACjC,QAAQ,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YACnC,OAAO;gBACH,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,IAAI,EAAE,CAAC,CAAC,WAAW;gBACnB,WAAW,EAAE,CAAC,CAAC,WAAW;aAC7B,CAAA;QACL,CAAC,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,MAAkB;QAC3C,MAAM,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;QACvC,QAAQ,CAAC,IAAI,GAAG,aAAa,CAAC;QAC9B,QAAQ,CAAC,QAAQ,GAAG,MAAM,CAAC,EAAE,CAAC;QAC9B,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC;QAClC,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC;QACzB,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC;QAClC,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YACpC,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;IAMD;;;OAGG;IACI,kBAAkB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,qFAAqF;IAC3I,CAAC;CACJ;AA7LD,0CA6LC;AAED,MAAa,WAAW;IAAxB;QACI,UAAK,GAAsB,EAAE,CAAC;IAwClC,CAAC;IAtCG;;;OAGG;IACI,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;IAED;;;;OAIG;IACI,qBAAqB,CAAC,aAAqB,YAAY;QAC1D,GAAG;QACH,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,GAAG,UAAU,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAClD,CAAC;QACD,OAAO,GAAG,CAAC;IACf,CAAC;IAED;;;;OAIG;IACI,gCAAgC,CAAC,aAAqB,YAAY;QACrE,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,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC3B,OAAO,IAAI,GAAG,UAAU,GAAG,CAAC,YAAY,IAAI,CAAC,WAAW,IAAI,CAAC;QACjE,CAAC;QACD,OAAO,IAAI,OAAO,GAAG,CAAC;IAC1B,CAAC;CACJ;AAzCD,kCAyCC"}

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@memberjunction/data-context",
+  "version": "0.9.2",
+  "description": "This library provides a set of objects that handle run-time loading of data contexts as well as types to be able to use across application tiers for interacting with data contexts.",
+  "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.124"
+  }
+}

package/readme.md

@@ -0,0 +1,3 @@
+# @memberjunction/data-context
+
+The `@memberjunction/data-context` library provides a set of objects that handle run-time loading of data contexts as well as types to be able to use across application tiers for interacting with data contexts.