@memberjunction/global 2.111.0 → 2.112.0

package/dist/generic/runReport.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RunReport = void 0;
+const Global_1 = require("../Global");
+/**
+ * Class used to run a report and return the results.
+ */
+class RunReport {
+    /**
+     * Optionally, you can pass in a provider to use for running the report. If you dont pass in a provider, the static provider will be used.
+     * @param provider
+     */
+    constructor(provider = null) {
+        this._provider = provider;
+    }
+    /**
+     * Returns the provider to be used for this instance, if one was passed in. Otherwise, it returns the static provider.
+     */
+    get ProviderToUse() {
+        return this._provider || RunReport.Provider;
+    }
+    async RunReport(params, contextUser) {
+        return this.ProviderToUse.RunReport(params, contextUser);
+    }
+    static get Provider() {
+        const g = Global_1.MJGlobal.Instance.GetGlobalObjectStore();
+        if (g)
+            return g[RunReport._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[RunReport._globalProviderKey] = value;
+        else
+            throw new Error('No global object store, so we cant set the static provider');
+    }
+}
+exports.RunReport = RunReport;
+RunReport._globalProviderKey = 'MJ_RunReportProvider';
+//# sourceMappingURL=runReport.js.map

package/dist/generic/runReport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runReport.js","sourceRoot":"","sources":["../../src/generic/runReport.ts"],"names":[],"mappings":";;;AAAA,sCAAqC;AAQrC;;GAEG;AACH,MAAa,SAAS;IAEpB;;;OAGG;IACH,YAAY,WAAsC,IAAI;QACpD,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,QAAQ,CAAC;IAC9C,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,MAAuB,EAAE,WAAsB;QACpE,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC3D,CAAC;IAGM,MAAM,KAAK,QAAQ;QACxB,MAAM,CAAC,GAAG,iBAAQ,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;QACnD,IAAI,CAAC;YAAE,OAAO,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;;YACzC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;IACrF,CAAC;IACM,MAAM,KAAK,QAAQ,CAAC,KAAyB;QAClD,MAAM,CAAC,GAAG,iBAAQ,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;QACnD,IAAI,CAAC;YAAE,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC;;YAC1C,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;IACrF,CAAC;;AA/BH,8BAgCC;AAXgB,4BAAkB,GAAW,sBAAsB,CAAC"}

package/dist/generic/securityInfo.d.ts

@@ -0,0 +1,355 @@
+import { BaseInfo } from "./baseInfo";
+import { IMetadataProvider } from "./interfaces";
+/**
+ * A list of all users who have or had access to the system.
+ * Contains user profile information, authentication details, and role assignments.
+ */
+export declare class UserInfo extends BaseInfo {
+    /**
+     * Unique identifier for the user
+     */
+    ID: string;
+    /**
+     * Name of the user that is used in various places in UIs/etc, can be anything including FirstLast, Email, a Handle, etc
+     */
+    Name: string;
+    /**
+     * User's first name or given name
+     */
+    FirstName: string;
+    /**
+     * User's last name or surname
+     */
+    LastName: string;
+    /**
+     * User's professional title or salutation
+     */
+    Title: string;
+    /**
+     * Unique email address for the user. This field must be unique across all users in the system
+     */
+    Email: string;
+    /**
+     * User account type (User, Owner)
+     */
+    Type: string;
+    /**
+     * Whether this user account is currently active and can log in
+     */
+    IsActive: boolean;
+    /**
+     * Type of record this user is linked to (None, Employee, Contact, etc.)
+     */
+    LinkedRecordType: 'None' | 'Employee' | 'Other';
+    /**
+     * Foreign key reference to the Employee entity
+     */
+    EmployeeID: number;
+    /**
+     * Foreign key reference to the Entities table
+     */
+    LinkedEntityID: number;
+    /**
+     * ID of the specific record this user is linked to
+     */
+    LinkedEntityRecordID: number;
+    /**
+     * Timestamp when the user record was created
+     */
+    __mj_CreatedAt: Date;
+    /**
+     * Timestamp when the user record was last updated
+     */
+    __mj_UpdatedAt: Date;
+    /**
+     * Concatenated first and last name
+     */
+    FirstLast: string;
+    /**
+     * Employee's concatenated first and last name
+     */
+    EmployeeFirstLast: string;
+    /**
+     * Employee's email address
+     */
+    EmployeeEmail: string;
+    /**
+     * Employee's job title
+     */
+    EmployeeTitle: string;
+    /**
+     * Name of the employee's supervisor
+     */
+    EmployeeSupervisor: string;
+    /**
+     * Email address of the employee's supervisor
+     */
+    EmployeeSupervisorEmail: string;
+    private _UserRoles;
+    /**
+     * Gets the roles assigned to this user.
+     * @returns {UserRoleInfo[]} Array of user role assignments
+     */
+    get UserRoles(): UserRoleInfo[];
+    /**
+     * Constructs a new instance of the UserInfo class, optionally initializing it with the provided metadata and initial data.
+     * If newGlobalRoles are provided, the user roles will be set up to validate against those roles instead of fetching them from the metadata provider.
+     * @param md
+     * @param initData
+     * @param newGlobalRoles
+     */
+    constructor(md?: IMetadataProvider, initData?: any);
+}
+/**
+ * Associates users with roles in the system, managing role-based access control and permission inheritance.
+ */
+export declare class UserRoleInfo extends BaseInfo {
+    /**
+     * Foreign key reference to the Users table
+     */
+    UserID: string;
+    /**
+     * Foreign key reference to the Roles table
+     */
+    RoleID: string;
+    /**
+     * Timestamp when the user-role association was created
+     */
+    __mj_CreatedAt: Date;
+    /**
+     * Timestamp when the user-role association was last updated
+     */
+    __mj_UpdatedAt: Date;
+    /**
+     * Name of the user
+     */
+    User: string;
+    /**
+     * Name of the role
+     */
+    Role: string;
+    constructor(initData: any);
+}
+/**
+ * Roles are used for security administration and can have zero to many Users as members.
+ * Defines groups of permissions that can be assigned to multiple users.
+ */
+export declare class RoleInfo extends BaseInfo {
+    /**
+     * Unique identifier for the role
+     */
+    ID: string;
+    /**
+     * Name of the role
+     */
+    Name: string;
+    /**
+     * Description of the role
+     */
+    Description: string;
+    /**
+     * The unique ID of the role in the directory being used for authentication, for example an ID in Azure
+     */
+    DirectoryID: string;
+    /**
+     * The name of the role in the database, this is used for auto-generating permission statements by CodeGen
+     */
+    SQLName: string;
+    /**
+     * Timestamp when the role was created
+     */
+    __mj_CreatedAt: Date;
+    /**
+     * Timestamp when the role was last updated
+     */
+    __mj_UpdatedAt: Date;
+    constructor(initData: any);
+}
+/**
+ * Defines data access rules that filter records based on user context, implementing fine-grained security at the row level.
+ */
+export declare class RowLevelSecurityFilterInfo extends BaseInfo {
+    /**
+     * Unique identifier for the row level security filter
+     */
+    ID: string;
+    /**
+     * Name of the row level security filter
+     */
+    Name: string;
+    /**
+     * Description of the row level security filter
+     */
+    Description: string;
+    /**
+     * SQL WHERE clause template that filters records based on user context variables
+     */
+    FilterText: string;
+    /**
+     * Timestamp when the filter was created
+     */
+    __mj_CreatedAt: Date;
+    /**
+     * Timestamp when the filter was last updated
+     */
+    __mj_UpdatedAt: Date;
+    constructor(initData: any);
+    /**
+     * Replaces user-specific tokens in the filter text with actual user values.
+     * Tokens are in the format {{UserFieldName}} where FieldName is any property of the UserInfo object.
+     * @param {UserInfo} user - The user whose properties will be substituted into the filter text
+     * @returns {string} The filter text with all user tokens replaced with actual values
+     */
+    MarkupFilterText(user: UserInfo): string;
+}
+/**
+ * Stores the fundamental permissions and access rights that can be granted to users and roles throughout the system.
+ */
+export declare class AuthorizationInfo extends BaseInfo {
+    /**
+     * Unique identifier for the authorization
+     */
+    ID: string;
+    /**
+     * The unique identifier for the parent authorization, if applicable
+     */
+    ParentID: string;
+    /**
+     * Name of the authorization
+     */
+    Name: string;
+    /**
+     * Indicates whether this authorization is currently active and can be granted to users or roles
+     */
+    IsActive: boolean;
+    /**
+     * When set to 1, Audit Log records are created whenever this authorization is invoked for a user
+     */
+    UseAuditLog: boolean;
+    /**
+     * Description of the authorization
+     */
+    Description: string;
+    /**
+     * Timestamp when the authorization was created
+     */
+    __mj_CreatedAt: Date;
+    /**
+     * Timestamp when the authorization was last updated
+     */
+    __mj_UpdatedAt: Date;
+    /**
+     * Name of the parent authorization
+     */
+    Parent: string;
+    private _AuthorizationRoles;
+    get Roles(): AuthorizationRoleInfo[];
+    constructor(md: IMetadataProvider, initData?: any);
+    /**
+     * Sets up the roles associated with this authorization using the provided metadata and initial data.
+     *
+     * @param {IMetadataProvider} md - The metadata provider to fetch role information.
+     * @param {AuthorizationRoleInfo[]} authorizationRoles - An array of `AuthorizationRoleInfo` instances or equivalent data to be associated with this authorization.
+     */
+    SetupAuthorizationRoles(md: IMetadataProvider, authorizationRoles: AuthorizationRoleInfo[]): void;
+    /**
+     * Determines if a given user can execute actions under this authorization based on their roles.
+     *
+     * @param {UserInfo} user - The user to check for execution rights.
+     * @returns {boolean} True if the user can execute actions under this authorization, otherwise false.
+     */
+    UserCanExecute(user: UserInfo): boolean;
+    /**
+     * Determines if a given role can execute actions under this authorization.
+     *
+     * @param {RoleInfo} role - The role to check for execution rights.
+     * @returns {boolean} True if the role can execute actions under this authorization, otherwise false.
+     */
+    RoleCanExecute(role: RoleInfo): boolean;
+}
+export declare const AuthorizationRoleType: {
+    readonly Allow: "Allow";
+    readonly Deny: "Deny";
+};
+export type AuthorizationRoleType = typeof AuthorizationRoleType[keyof typeof AuthorizationRoleType];
+/**
+ * Links authorizations to roles, defining which permissions are granted to users assigned to specific roles in the system.
+ */
+export declare class AuthorizationRoleInfo extends BaseInfo {
+    /**
+     * Unique identifier for the authorization-role mapping
+     */
+    ID: string;
+    /**
+     * Foreign key reference to the Authorizations table
+     */
+    AuthorizationID: string;
+    /**
+     * Foreign key reference to the Roles table
+     */
+    RoleID: string;
+    /**
+     * Specifies whether this authorization is granted to ('Allow') or explicitly denied ('Deny') for the role. Deny overrides Allow from all other roles a user may be part of
+     */
+    Type: string;
+    /**
+     * Timestamp when the authorization-role mapping was created
+     */
+    __mj_CreatedAt: Date;
+    /**
+     * Timestamp when the authorization-role mapping was last updated
+     */
+    __mj_UpdatedAt: Date;
+    /**
+     * Name of the authorization
+     */
+    Authorization: string;
+    /**
+     * Name of the role
+     */
+    Role: string;
+    private _RoleInfo;
+    get RoleInfo(): RoleInfo;
+    AuthorizationType(): AuthorizationRoleType;
+    _setRole(role: RoleInfo): void;
+    constructor(initData: any);
+}
+/**
+ * Defines the types of events that can be recorded in the audit log, enabling categorization and filtering of system activities.
+ */
+export declare class AuditLogTypeInfo extends BaseInfo {
+    /**
+     * Unique identifier for the audit log type
+     */
+    ID: string;
+    /**
+     * Foreign key reference to the parent Audit Log Type
+     */
+    ParentID: string;
+    /**
+     * Name of the audit log type
+     */
+    Name: string;
+    /**
+     * Description of the audit log type
+     */
+    Description: string;
+    /**
+     * Name of the associated authorization
+     */
+    AuthorizationName: string;
+    /**
+     * Timestamp when the audit log type was created
+     */
+    __mj_CreatedAt: Date;
+    /**
+     * Timestamp when the audit log type was last updated
+     */
+    __mj_UpdatedAt: Date;
+    /**
+     * Name of the parent audit log type
+     */
+    Parent: string;
+    constructor(initData: any);
+}
+//# sourceMappingURL=securityInfo.d.ts.map

package/dist/generic/securityInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"securityInfo.d.ts","sourceRoot":"","sources":["../../src/generic/securityInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEjD;;;GAGG;AACH,qBAAa,QAAS,SAAQ,QAAQ;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAQ;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAO;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAO;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAO;IAEvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAO;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAO;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAO;IAEnB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAO;IAExB;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAO;IAEtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAO;IAEzB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAO;IAE7B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAO;IAEnC;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAE3B;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAG3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAO;IAExB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAO;IAEhC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAO;IAE5B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAO;IAE5B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAO;IAEjC;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAO;IAEtC,OAAO,CAAC,UAAU,CAAqB;IACvC;;;OAGG;IACH,IAAW,SAAS,IAAI,YAAY,EAAE,CAErC;IAED;;;;;;OAMG;gBACU,EAAE,GAAE,iBAAwB,EAAE,QAAQ,GAAE,GAAU;CAOlE;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,QAAQ;IACtC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAO;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAO;IAErB;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAE3B;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAG3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAO;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAO;gBAEN,QAAQ,EAAE,GAAG;CAI7B;AAED;;;GAGG;AACH,qBAAa,QAAS,SAAQ,QAAQ;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAO;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAO;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAO;IAE1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAO;IAE1B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAO;IAEtB;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAE3B;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;gBAEd,QAAQ,EAAE,GAAG;CAI7B;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,QAAQ;IACpD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAO;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAO;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAO;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAO;IAEzB;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAE3B;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;gBAEd,QAAQ,EAAE,GAAG;IAK1B;;;;;OAKG;IACI,gBAAgB,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM;CAclD;AAED;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,QAAQ;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAO;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAO;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAO;IAEnB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAO;IAExB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAO;IAE3B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAO;IAE1B;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAE3B;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAG3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd,OAAO,CAAC,mBAAmB,CAA8B;IACzD,IAAI,KAAK,IAAI,qBAAqB,EAAE,CAEnC;gBAEY,EAAE,EAAE,iBAAiB,EAAE,QAAQ,GAAE,GAAU;IAOxD;;;;;OAKG;IACI,uBAAuB,CAAC,EAAE,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,qBAAqB,EAAE;IAgBjG;;;;;OAKG;IACI,cAAc,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO;IAW9C;;;;;OAKG;IACI,cAAc,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO;CAMjD;AAED,eAAO,MAAM,qBAAqB;;;CAGxB,CAAC;AAEX,MAAM,MAAM,qBAAqB,GAAG,OAAO,qBAAqB,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAGrG;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,QAAQ;IAC/C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAO;IAEjB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAO;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAO;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAO;IAEnB;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAE3B;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAG3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ,OAAO,CAAC,SAAS,CAAiB;IAClC,IAAW,QAAQ,IAAI,QAAQ,CAE9B;IAEM,iBAAiB,IAAI,qBAAqB;IAIjD,QAAQ,CAAC,IAAI,EAAE,QAAQ;gBAIV,QAAQ,EAAE,GAAG;CAI7B;AAGD;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,QAAQ;IAC1C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAO;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAO;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAO;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAO;IAE1B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAO;IAEhC;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAE3B;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAG3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;gBAED,QAAQ,EAAE,GAAG;CAI7B"}