@memberjunction/global 2.111.0 → 2.112.0

package/dist/views/viewInfo.d.ts

@@ -0,0 +1,121 @@
+import { BaseInfo } from '../generic/baseInfo';
+import { EntityFieldInfo, EntityInfo } from '../generic/entityInfo';
+import { IMetadataProvider } from '../generic/interfaces';
+export declare class ViewColumnInfo extends BaseInfo {
+    ID: number;
+    Name: string;
+    DisplayName: string;
+    hidden: boolean;
+    width?: number;
+    orderIndex?: number;
+    EntityField: EntityFieldInfo;
+    constructor(initData?: any);
+}
+export declare const ViewFilterLogicInfo: {
+    readonly And: "And";
+    readonly Or: "Or";
+};
+export type ViewFilterLogicInfo = typeof ViewFilterLogicInfo[keyof typeof ViewFilterLogicInfo];
+export declare class ViewFilterInfo extends BaseInfo {
+    logicOperator: ViewFilterLogicInfo;
+    field: string;
+    operator: string;
+    value: string;
+    filters: ViewFilterInfo[];
+    constructor(initData?: any);
+}
+export declare class ViewGridState {
+    sortSettings?: any;
+    columnSettings?: any;
+    filter?: any;
+}
+/**
+ * This class represents a View in the system. A View is a saved set of filters, columns, and other settings that can be applied to a grid to show a specific set of data.
+ */
+export declare class ViewInfo extends BaseInfo {
+    /**
+     * Unique identifier for the view record
+     */
+    ID: string;
+    /**
+     * Foreign key reference to the user who created this view
+     */
+    UserID: number;
+    /**
+     * Foreign key reference to the entity this view is based on
+     */
+    EntityID: number;
+    /**
+     * Name of the view for display and reference
+     */
+    Name: string;
+    /**
+     * Detailed description of what this view displays and its purpose
+     */
+    Description: string;
+    /**
+     * Foreign key reference to the View Categories entity for organizing views
+     */
+    CategoryID: number;
+    /**
+     * When true, this view is available to other users besides the creator
+     */
+    IsShared: boolean;
+    /**
+     * When true, this view is the default view for the entity
+     */
+    IsDefault: boolean;
+    /**
+     * JSON string containing the complete grid state including columns, sorting, and filters
+     */
+    GridState: string;
+    /**
+     * JSON string containing the filter configuration for this view
+     */
+    FilterState: string;
+    /**
+     * JSON string containing custom filter configuration added by the user
+     */
+    CustomFilterState: string;
+    /**
+     * SQL WHERE clause generated from the filter state for query execution
+     */
+    WhereClause: string;
+    /**
+     * Custom SQL WHERE clause that can be added to supplement the generated WHERE clause
+     */
+    CustomWhereClause: string;
+    /**
+     * Date and time when this view was created
+     */
+    __mj_CreatedAt: Date;
+    /**
+     * Date and time when this view was last updated
+     */
+    __mj_UpdatedAt: Date;
+    /**
+     * Name of the user who owns this view (from related User entity)
+     */
+    UserName: string;
+    /**
+     * Type of user who owns this view (from related User entity)
+     */
+    UserType: string;
+    /**
+     * Name of the entity this view is based on (from related Entity)
+     */
+    Entity: string;
+    /**
+     * Base view name for the entity used in queries
+     */
+    EntityBaseView: string;
+    private _Filter;
+    get Filter(): ViewFilterInfo[];
+    private _Columns;
+    get Columns(): ViewColumnInfo[];
+    private _EntityInfo;
+    get EntityInfo(): EntityInfo;
+    InitFromData(md: IMetadataProvider, initData: any): void;
+    constructor(md: IMetadataProvider, initData?: any);
+}
+//# sourceMappingURL=viewInfo.d.ts.map

package/dist/views/viewInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"viewInfo.d.ts","sourceRoot":"","sources":["../../src/views/viewInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAC9C,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAG1D,qBAAa,cAAe,SAAQ,QAAQ;IACxC,EAAE,EAAE,MAAM,CAAO;IACjB,IAAI,EAAE,MAAM,CAAO;IACnB,WAAW,EAAE,MAAM,CAAO;IAC1B,MAAM,EAAE,OAAO,CAAO;IACtB,KAAK,CAAC,EAAE,MAAM,CAAO;IACrB,UAAU,CAAC,EAAE,MAAM,CAAO;IAE1B,WAAW,EAAE,eAAe,CAAO;gBAEtB,QAAQ,GAAE,GAAU;CAIpC;AAGD,eAAO,MAAM,mBAAmB;;;CAGtB,CAAC;AAEX,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAG/F,qBAAa,cAAe,SAAQ,QAAQ;IACxC,aAAa,EAAE,mBAAmB,CAAO;IAEzC,KAAK,EAAE,MAAM,CAAO;IACpB,QAAQ,EAAE,MAAM,CAAO;IACvB,KAAK,EAAE,MAAM,CAAO;IAEpB,OAAO,EAAE,cAAc,EAAE,CAAK;gBAEjB,QAAQ,GAAE,GAAU;CAUpC;AAED,qBAAa,aAAa;IACtB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,MAAM,CAAC,EAAE,GAAG,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,QAAQ;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAO;IACjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAO;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAO;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAO;IACnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAO;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAO;IACzB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAO;IACxB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAO;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAO;IACxB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAO;IAC1B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAO;IAChC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAO;IAC1B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAO;IAChC;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAC3B;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAC3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAO;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAO;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAO;IACrB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAO;IAE7B,OAAO,CAAC,OAAO,CAAuB;IACtC,IAAW,MAAM,IAAI,cAAc,EAAE,CAEpC;IAED,OAAO,CAAC,QAAQ,CAAuB;IACvC,IAAW,OAAO,IAAI,cAAc,EAAE,CAErC;IAED,OAAO,CAAC,WAAW,CAAmB;IACtC,IAAW,UAAU,IAAI,UAAU,CAElC;IAEM,YAAY,CAAC,EAAE,EAAE,iBAAiB,EAAE,QAAQ,EAAE,GAAG;gBAyC3C,EAAE,EAAE,iBAAiB,EAAE,QAAQ,GAAE,GAAU;CAI3D"}

package/dist/views/viewInfo.js

@@ -0,0 +1,182 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewInfo = exports.ViewGridState = exports.ViewFilterInfo = exports.ViewFilterLogicInfo = exports.ViewColumnInfo = void 0;
+const baseInfo_1 = require("../generic/baseInfo");
+const logging_1 = require("../generic/logging");
+class ViewColumnInfo extends baseInfo_1.BaseInfo {
+    constructor(initData = null) {
+        super();
+        this.ID = null;
+        this.Name = null;
+        this.DisplayName = null;
+        this.hidden = null;
+        this.width = null;
+        this.orderIndex = null;
+        this.EntityField = null;
+        this.copyInitData(initData);
+    }
+}
+exports.ViewColumnInfo = ViewColumnInfo;
+exports.ViewFilterLogicInfo = {
+    And: 'And',
+    Or: 'Or',
+};
+class ViewFilterInfo extends baseInfo_1.BaseInfo {
+    constructor(initData = null) {
+        super();
+        this.logicOperator = null;
+        this.field = null;
+        this.operator = null;
+        this.value = null;
+        this.filters = [];
+        this.copyInitData(initData);
+        if (initData && initData.logic) {
+            this.logicOperator = initData.logic.trim().toLowerCase() == 'and' ? exports.ViewFilterLogicInfo.And : exports.ViewFilterLogicInfo.Or;
+        }
+        if (initData && initData.filters) {
+            this.filters = initData.filters.map(f => new ViewFilterInfo(f));
+        }
+    }
+}
+exports.ViewFilterInfo = ViewFilterInfo;
+class ViewGridState {
+}
+exports.ViewGridState = ViewGridState;
+/**
+ * This class represents a View in the system. A View is a saved set of filters, columns, and other settings that can be applied to a grid to show a specific set of data.
+ */
+class ViewInfo extends baseInfo_1.BaseInfo {
+    get Filter() {
+        return this._Filter;
+    }
+    get Columns() {
+        return this._Columns;
+    }
+    get EntityInfo() {
+        return this._EntityInfo;
+    }
+    InitFromData(md, initData) {
+        try {
+            if (initData) {
+                this.copyInitData(initData);
+                if (initData.EntityID) {
+                    const mdEntities = md.Entities;
+                    const match = mdEntities.find(e => e.ID == initData.EntityID);
+                    if (match)
+                        this._EntityInfo = match;
+                }
+                else if (initData._EntityInfo)
+                    this._EntityInfo = initData._EntityInfo;
+                // set up the filters and the columns
+                if (initData.GridState) {
+                    const gridState = JSON.parse(initData.GridState);
+                    if (gridState && gridState.columnSettings) {
+                        this._Columns = gridState.columnSettings.map(c => {
+                            // find the entity field and put it in place inside the View Metadata for easy access
+                            if (c) {
+                                // check to make sure the current item is non-null to ensure metadata isn't messed up 
+                                const field = this._EntityInfo.Fields.find(f => f.Name.trim().toLowerCase() == c.Name.trim().toLowerCase());
+                                return new ViewColumnInfo({ ...c, EntityField: field });
+                            }
+                            else {
+                                (0, logging_1.LogError)('null column setting found in view grid state for columns - ViewID: ' + initData.ID);
+                            }
+                        });
+                    }
+                }
+                if (initData.FilterState) {
+                    this._Filter = [new ViewFilterInfo(JSON.parse(initData.FilterState))];
+                }
+            }
+        }
+        catch (e) {
+            (0, logging_1.LogError)(e);
+            throw e;
+        }
+    }
+    constructor(md, initData = null) {
+        super();
+        /**
+         * Unique identifier for the view record
+         */
+        this.ID = null;
+        /**
+         * Foreign key reference to the user who created this view
+         */
+        this.UserID = null;
+        /**
+         * Foreign key reference to the entity this view is based on
+         */
+        this.EntityID = null;
+        /**
+         * Name of the view for display and reference
+         */
+        this.Name = null;
+        /**
+         * Detailed description of what this view displays and its purpose
+         */
+        this.Description = null;
+        /**
+         * Foreign key reference to the View Categories entity for organizing views
+         */
+        this.CategoryID = null;
+        /**
+         * When true, this view is available to other users besides the creator
+         */
+        this.IsShared = null;
+        /**
+         * When true, this view is the default view for the entity
+         */
+        this.IsDefault = null;
+        /**
+         * JSON string containing the complete grid state including columns, sorting, and filters
+         */
+        this.GridState = null;
+        /**
+         * JSON string containing the filter configuration for this view
+         */
+        this.FilterState = null;
+        /**
+         * JSON string containing custom filter configuration added by the user
+         */
+        this.CustomFilterState = null;
+        /**
+         * SQL WHERE clause generated from the filter state for query execution
+         */
+        this.WhereClause = null;
+        /**
+         * Custom SQL WHERE clause that can be added to supplement the generated WHERE clause
+         */
+        this.CustomWhereClause = null;
+        /**
+         * Date and time when this view was created
+         */
+        this.__mj_CreatedAt = null;
+        /**
+         * Date and time when this view was last updated
+         */
+        this.__mj_UpdatedAt = null;
+        /**
+         * Name of the user who owns this view (from related User entity)
+         */
+        this.UserName = null;
+        /**
+         * Type of user who owns this view (from related User entity)
+         */
+        this.UserType = null;
+        /**
+         * Name of the entity this view is based on (from related Entity)
+         */
+        this.Entity = null;
+        /**
+         * Base view name for the entity used in queries
+         */
+        this.EntityBaseView = null;
+        this._Filter = [];
+        this._Columns = [];
+        this._EntityInfo = null;
+        this.InitFromData(md, initData);
+    }
+}
+exports.ViewInfo = ViewInfo;
+//# sourceMappingURL=viewInfo.js.map

package/dist/views/viewInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"viewInfo.js","sourceRoot":"","sources":["../../src/views/viewInfo.ts"],"names":[],"mappings":";;;AAAA,kDAA8C;AAG9C,gDAA8C;AAE9C,MAAa,cAAe,SAAQ,mBAAQ;IAUxC,YAAa,WAAgB,IAAI;QAC7B,KAAK,EAAE,CAAA;QAVX,OAAE,GAAW,IAAI,CAAA;QACjB,SAAI,GAAW,IAAI,CAAA;QACnB,gBAAW,GAAW,IAAI,CAAA;QAC1B,WAAM,GAAY,IAAI,CAAA;QACtB,UAAK,GAAY,IAAI,CAAA;QACrB,eAAU,GAAY,IAAI,CAAA;QAE1B,gBAAW,GAAoB,IAAI,CAAA;QAI/B,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;IAC/B,CAAC;CACJ;AAdD,wCAcC;AAGY,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,KAAK;IACV,EAAE,EAAE,IAAI;CACF,CAAC;AAKX,MAAa,cAAe,SAAQ,mBAAQ;IASxC,YAAa,WAAgB,IAAI;QAC7B,KAAK,EAAE,CAAA;QATX,kBAAa,GAAwB,IAAI,CAAA;QAEzC,UAAK,GAAW,IAAI,CAAA;QACpB,aAAQ,GAAW,IAAI,CAAA;QACvB,UAAK,GAAW,IAAI,CAAA;QAEpB,YAAO,GAAqB,EAAE,CAAA;QAI1B,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;QAC3B,IAAI,QAAQ,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;YAC7B,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,IAAI,KAAK,CAAC,CAAC,CAAC,2BAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,2BAAmB,CAAC,EAAE,CAAA;QACxH,CAAC;QACD,IAAI,QAAQ,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;YAC/B,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC,CAAA;QACnE,CAAC;IACL,CAAC;CACJ;AAnBD,wCAmBC;AAED,MAAa,aAAa;CAIzB;AAJD,sCAIC;AAED;;GAEG;AACH,MAAa,QAAS,SAAQ,mBAAQ;IA+ElC,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,OAAO,CAAA;IACvB,CAAC;IAGD,IAAW,OAAO;QACd,OAAO,IAAI,CAAC,QAAQ,CAAA;IACxB,CAAC;IAGD,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,WAAW,CAAA;IAC3B,CAAC;IAEM,YAAY,CAAC,EAAqB,EAAE,QAAa;QACpD,IAAI,CAAC;YACD,IAAI,QAAQ,EAAE,CAAC;gBACX,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;gBAC3B,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;oBACpB,MAAM,UAAU,GAAG,EAAE,CAAC,QAAQ,CAAC;oBAC/B,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAAA;oBAC7D,IAAI,KAAK;wBACL,IAAI,CAAC,WAAW,GAAG,KAAK,CAAA;gBAChC,CAAC;qBACI,IAAI,QAAQ,CAAC,WAAW;oBACzB,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAA;gBAE3C,qCAAqC;gBACrC,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;oBACrB,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;oBAChD,IAAI,SAAS,IAAI,SAAS,CAAC,cAAc,EAAE,CAAC;wBACxC,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;4BAC7C,qFAAqF;4BACrF,IAAI,CAAC,EAAE,CAAC;gCACJ,sFAAsF;gCACtF,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAA;gCAC3G,OAAO,IAAI,cAAc,CAAC,EAAC,GAAG,CAAC,EAAE,WAAW,EAAE,KAAK,EAAC,CAAC,CAAA;4BACzD,CAAC;iCACI,CAAC;gCACF,IAAA,kBAAQ,EAAC,qEAAqE,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAA;4BACjG,CAAC;wBACL,CAAC,CAAC,CAAA;oBACN,CAAC;gBACL,CAAC;gBACD,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;oBACvB,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;gBACzE,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAM,CAAC,EAAE,CAAC;YACN,IAAA,kBAAQ,EAAC,CAAC,CAAC,CAAA;YACX,MAAM,CAAC,CAAA;QACX,CAAC;IACL,CAAC;IAED,YAAa,EAAqB,EAAE,WAAgB,IAAI;QACpD,KAAK,EAAE,CAAC;QAtIZ;;WAEG;QACH,OAAE,GAAW,IAAI,CAAA;QACjB;;WAEG;QACH,WAAM,GAAW,IAAI,CAAA;QACrB;;WAEG;QACH,aAAQ,GAAW,IAAI,CAAA;QACvB;;WAEG;QACH,SAAI,GAAW,IAAI,CAAA;QACnB;;WAEG;QACH,gBAAW,GAAW,IAAI,CAAA;QAC1B;;WAEG;QACH,eAAU,GAAW,IAAI,CAAA;QACzB;;WAEG;QACH,aAAQ,GAAY,IAAI,CAAA;QACxB;;WAEG;QACH,cAAS,GAAY,IAAI,CAAA;QACzB;;WAEG;QACH,cAAS,GAAW,IAAI,CAAA;QACxB;;WAEG;QACH,gBAAW,GAAW,IAAI,CAAA;QAC1B;;WAEG;QACH,sBAAiB,GAAW,IAAI,CAAA;QAChC;;WAEG;QACH,gBAAW,GAAW,IAAI,CAAA;QAC1B;;WAEG;QACH,sBAAiB,GAAW,IAAI,CAAA;QAChC;;WAEG;QACH,mBAAc,GAAS,IAAI,CAAA;QAC3B;;WAEG;QACH,mBAAc,GAAS,IAAI,CAAA;QAC3B;;WAEG;QACH,aAAQ,GAAW,IAAI,CAAA;QACvB;;WAEG;QACH,aAAQ,GAAW,IAAI,CAAA;QACvB;;WAEG;QACH,WAAM,GAAW,IAAI,CAAA;QACrB;;WAEG;QACH,mBAAc,GAAW,IAAI,CAAA;QAErB,YAAO,GAAqB,EAAE,CAAA;QAK9B,aAAQ,GAAqB,EAAE,CAAA;QAK/B,gBAAW,GAAe,IAAI,CAAA;QAgDlC,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;IACpC,CAAC;CACJ;AA1ID,4BA0IC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/global",
-  "version": "2.111.0",
+  "version": "2.112.0",
   "description": "MemberJunction: Global Object - Needed for ALL other MJ components",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",