@memberjunction/core 0.9.172 → 0.9.177

package/dist/generic/runView.d.ts

@@ -0,0 +1,106 @@
+import { IRunViewProvider, RunViewResult } from './interfaces';
+import { UserInfo } from './securityInfo';
+import { BaseEntity } from './baseEntity';
+/**
+ * Parameters for running either a stored or dynamic view.
+ * A stored view is a view that is saved in the database and can be run either by ID or Name.
+ * A dynamic view is one that is not stored in the database and you provide parameters to return data as
+ * desired programatically.
+ */
+export type RunViewParams = {
+    /**
+     * optional - ID of the UserView record to run, if provided, ViewName is ignored
+     */
+    ViewID?: number;
+    /**
+     * optional - Name of the UserView record to run, if you are using this, make sure to use a naming convention
+     * so that your view names are unique. For example use a prefix like __Entity_View_ etc so that you're
+     * likely to have a single result. If more than one view is available that matches a provided view name an
+     * exception will be thrown.
+     */
+    ViewName?: string;
+    /**
+     * optional - this is the loaded instance of the BaseEntity (UserViewEntityComplete or a subclass of it).
+     * This is the preferred parameter to use IF you already have a view entity object loaded up in your code
+     * becuase by passing this in, the RunView() method doesn't have to lookup all the metadata for the view and it is faster.
+     * If you provide ViewEntity, ViewID/ViewName are ignored.
+     */
+    ViewEntity?: BaseEntity;
+    /**
+     * optional - this is only used if ViewID/ViewName/ViewEntity are not provided, it is used for
+     * Dynamic Views in combination with the optional ExtraFilter
+     */
+    EntityName?: string;
+    /**
+     * An optional SQL WHERE clause that you can add to the existing filters on a stored view. For dynamic views, you can either
+     * run a view without a filter (if the entity definition allows it with AllowAllRowsAPI=1) or filter with any valid SQL WHERE clause.
+     */
+    ExtraFilter?: string;
+    /**
+     * An optional SQL ORDER BY clause that you can use for dynamic views, as well as to OVERRIDE the stored view's sorting order.
+     */
+    OrderBy?: string;
+    /**
+     * An optional array of field names that you want returned. The RunView() function will always return ID so you don't need to ask for that. If you leave this null then
+     * for a dynamic view all fields are returned, and for stored views, the fields stored in it view configuration are returned.
+      */
+    Fields?: string[];
+    /**
+     * optional - string that represents a user "search" - typically from a text search option in a UI somewhere. This field is then used in the view filtering to search whichever fields are configured to be included in search in the Entity Fields definition.
+     * Search String is combined with the stored view filters as well as ExtraFilter with an AND.
+     */
+    UserSearchString?: string;
+    /**
+     * optional - if provided, records that were returned in the specified UserViewRunID will NOT be allowed in the result set.
+     * This is useful if you want to run a particular view over time and exclude a specific prior run's resulting data set. If you
+     * want to exclude ALL data returned from ALL prior runs, use the ExcludeDataFromAllPriorViewRuns property instead.
+     */
+    ExcludeUserViewRunID?: number;
+    /**
+     * optional - if set to true, the resulting data will filter out ANY records that were ever returned by this view, when the SaveViewResults property was set to true.
+     * This is useful if you want to run a particular view over time and make sure the results returned each time are new to the view.
+     */
+    ExcludeDataFromAllPriorViewRuns?: boolean;
+    /**
+     * optional - if you are providing the optional ExcludeUserViewRunID property, you can also optionally provide
+     * this filter which will negate the specific list of record IDs that are excluded by the ExcludeUserViewRunID property.
+     * This can be useful if you want to ensure a certain class of data is always allowed into your view and not filtered out
+     * by a prior view run.
+     *
+     */
+    OverrideExcludeFilter?: string;
+    /**
+     * optional - if set to true, the LIST OF ID values from the view run will be stored in the User View Runs entity and the
+     * newly created UserViewRun.ID value will be returned in the RunViewResult that the RunView() function sends back to ya.
+     */
+    SaveViewResults?: boolean;
+    /**
+     * optional - if set to true, if there IS any UserViewMaxRows property set for the entity in question, it will be IGNORED. This is useful in scenarios where you
+     * want to programmatically run a view and get ALL the data back, regardless of the MaxRows setting on the entity.
+     */
+    IgnoreMaxRows?: boolean;
+    /**
+     * optional - if set to true, the view run will ALWAYS be logged to the Audit Log, regardless of the entity's property settings for logging view runs.
+     */
+    ForceAuditLog?: boolean;
+    /**
+     * optional - if provided and either ForceAuditLog is set, or the entity's property settings for logging view runs are set to true, this will be used as the Audit Log Description.
+     */
+    AuditLogDescription?: string;
+};
+/**
+ * Class for runnings views in a generic, tier-independent manner - uses a provider model for
+ * implementation transparently from the viewpoint of the consumer of the class.
+ */
+export declare class RunView {
+    /**
+     * Runs a view based on the provided parameters, see documentation for RunViewParams for more
+     * @param params
+     * @param contextUser if provided, this user is used for permissions and logging. For server based calls, this is generally required because there is no "Current User" since this object is shared across all requests.
+     * @returns
+     */
+    RunView(params: RunViewParams, contextUser?: UserInfo): Promise<RunViewResult>;
+    private static _globalProviderKey;
+    static get Provider(): IRunViewProvider;
+    static set Provider(value: IRunViewProvider);
+}

package/dist/generic/runView.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RunView = void 0;
+const global_1 = require("@memberjunction/global");
+/**
+ * Class for runnings views in a generic, tier-independent manner - uses a provider model for
+ * implementation transparently from the viewpoint of the consumer of the class.
+ */
+class RunView {
+    /**
+     * Runs a view based on the provided parameters, see documentation for RunViewParams for more
+     * @param params
+     * @param contextUser if provided, this user is used for permissions and logging. For server based calls, this is generally required because there is no "Current User" since this object is shared across all requests.
+     * @returns
+     */
+    async RunView(params, contextUser) {
+        return RunView.Provider.RunView(params, contextUser);
+    }
+    static get Provider() {
+        const g = global_1.MJGlobal.Instance.GetGlobalObjectStore();
+        if (g)
+            return g[RunView._globalProviderKey];
+        else
+            throw new Error('No global object store, so we cant get the static provider');
+    }
+    static set Provider(value) {
+        const g = global_1.MJGlobal.Instance.GetGlobalObjectStore();
+        if (g)
+            g[RunView._globalProviderKey] = value;
+        else
+            throw new Error('No global object store, so we cant set the static provider');
+    }
+}
+exports.RunView = RunView;
+RunView._globalProviderKey = 'MJ_RunViewProvider';
+//# sourceMappingURL=runView.js.map

package/dist/generic/runView.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runView.js","sourceRoot":"","sources":["../../src/generic/runView.ts"],"names":[],"mappings":";;;AAAA,mDAAkD;AA6FlD;;;GAGG;AACH,MAAa,OAAO;IAChB;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,MAAqB,EAAE,WAAsB;QAC9D,OAAO,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACzD,CAAC;IAGM,MAAM,KAAK,QAAQ;QACtB,MAAM,CAAC,GAAG,iBAAQ,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;QACnD,IAAI,CAAC;YACD,OAAO,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;;YAErC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;IACtF,CAAC;IACM,MAAM,KAAK,QAAQ,CAAC,KAAuB;QAC9C,MAAM,CAAC,GAAG,iBAAQ,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;QACnD,IAAI,CAAC;YACD,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC;;YAEtC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;IACtF,CAAC;;AAzBL,0BA2BC;AAhBkB,0BAAkB,GAAW,oBAAoB,CAAC"}

package/dist/generic/viewInfo.d.ts

@@ -0,0 +1,59 @@
+import { BaseInfo } from './baseInfo';
+import { EntityFieldInfo, EntityInfo } from './entityInfo';
+import { IMetadataProvider } from './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;
+}
+export declare class ViewInfo extends BaseInfo {
+    UserID: number;
+    EntityID: number;
+    Name: string;
+    Description: string;
+    CategoryID: number;
+    IsShared: boolean;
+    IsDefault: boolean;
+    GridState: string;
+    FilterState: string;
+    CustomFilterState: string;
+    WhereClause: string;
+    CustomWhereClause: string;
+    CreatedAt: Date;
+    UpdatedAt: Date;
+    UserName: string;
+    UserType: string;
+    Entity: string;
+    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);
+}

package/dist/generic/viewInfo.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewInfo = exports.ViewGridState = exports.ViewFilterInfo = exports.ViewFilterLogicInfo = exports.ViewColumnInfo = void 0;
+const baseInfo_1 = require("./baseInfo");
+const logging_1 = require("./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;
+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();
+        this.UserID = null;
+        this.EntityID = null;
+        this.Name = null;
+        this.Description = null;
+        this.CategoryID = null;
+        this.IsShared = null;
+        this.IsDefault = null;
+        this.GridState = null;
+        this.FilterState = null;
+        this.CustomFilterState = null;
+        this.WhereClause = null;
+        this.CustomWhereClause = null;
+        this.CreatedAt = null;
+        this.UpdatedAt = null;
+        this.UserName = null;
+        this.UserType = null;
+        this.Entity = null;
+        this.EntityBaseView = null;
+        this._Filter = [];
+        this._Columns = [];
+        this._EntityInfo = null;
+        this.InitFromData(md, initData);
+    }
+}
+exports.ViewInfo = ViewInfo;
+//# sourceMappingURL=viewInfo.js.map

package/dist/generic/viewInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"viewInfo.js","sourceRoot":"","sources":["../../src/generic/viewInfo.ts"],"names":[],"mappings":";;;AAAA,yCAAqC;AAGrC,uCAAqC;AAErC,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,MAAa,QAAS,SAAQ,mBAAQ;IAqBlC,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;QA5EZ,WAAM,GAAW,IAAI,CAAA;QACrB,aAAQ,GAAW,IAAI,CAAA;QACvB,SAAI,GAAW,IAAI,CAAA;QACnB,gBAAW,GAAW,IAAI,CAAA;QAC1B,eAAU,GAAW,IAAI,CAAA;QACzB,aAAQ,GAAY,IAAI,CAAA;QACxB,cAAS,GAAY,IAAI,CAAA;QACzB,cAAS,GAAW,IAAI,CAAA;QACxB,gBAAW,GAAW,IAAI,CAAA;QAC1B,sBAAiB,GAAW,IAAI,CAAA;QAChC,gBAAW,GAAW,IAAI,CAAA;QAC1B,sBAAiB,GAAW,IAAI,CAAA;QAChC,cAAS,GAAS,IAAI,CAAA;QACtB,cAAS,GAAS,IAAI,CAAA;QACtB,aAAQ,GAAW,IAAI,CAAA;QACvB,aAAQ,GAAW,IAAI,CAAA;QACvB,WAAM,GAAW,IAAI,CAAA;QACrB,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;AAhFD,4BAgFC"}

package/package.json

@@ -1,24 +1,24 @@
 {
-  "name": "@memberjunction/core",
-  "version": "0.9.172",
-  "description": "MemberJunction: Core Library including Metadata, Application, Entity Retrieval and Manipulation, and Utilities",
-  "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/global": "^0.9.153"
-  }
+    "name":  "@memberjunction/core",
+    "version":  "0.9.177",
+    "description":  "MemberJunction: Core Library including Metadata, Application, Entity Retrieval and Manipulation, and Utilities",
+    "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\" \u0026\u0026 exit 1"
+                },
+    "author":  "MemberJunction.com",
+    "license":  "ISC",
+    "devDependencies":  {
+                            "ts-node-dev":  "^2.0.0",
+                            "typescript":  "^5.3.3"
+                        },
+    "dependencies":  {
+                         "@memberjunction/global":  "^0.9.158"
+                     }
 }