@memberjunction/core 2.72.0 → 2.74.0

package/dist/generic/applicationInfo.d.ts

@@ -1,46 +1,137 @@
 import { BaseInfo } from './baseInfo';
 import { EntityInfo } from './entityInfo';
 import { IMetadataProvider } from './interfaces';
+/**
+ * Stores configuration settings and preferences for applications, including key-value pairs for runtime parameters and user-specific customizations.
+ */
 export declare class ApplicationSettingInfo extends BaseInfo {
+    /**
+     * Unique identifier for the application setting
+     */
     ID: string;
+    /**
+     * Name of the application this setting belongs to
+     */
     ApplicationName: string;
+    /**
+     * Name of the setting
+     */
     Name: string;
+    /**
+     * The setting value, can be simple text, numbers, booleans, or JSON for complex configuration objects
+     */
     Value: string;
+    /**
+     * Additional comments about the setting
+     */
     Comments: string;
+    /**
+     * Timestamp when the record was created
+     */
     __mj_CreatedAt: Date;
+    /**
+     * Timestamp when the record was last updated
+     */
     __mj_UpdatedAt: Date;
     constructor(initData?: any);
 }
+/**
+ * List of entities within each application. An application can have any number of entities and an entity can be part of any number of applications.
+ */
 export declare class ApplicationEntityInfo extends BaseInfo {
+    /**
+     * Unique identifier for the application entity relationship
+     */
     ID: string;
+    /**
+     * Name of the application
+     */
     ApplicationName: string;
+    /**
+     * ID of the entity linked to this application
+     */
     EntityID: string;
+    /**
+     * Display order of this entity within the application, lower numbers appear first in navigation and menus
+     */
     Sequence: number;
+    /**
+     * When set to true, the entity will be included by default for a new user when they first access the application in question
+     */
     DefaultForNewUser: boolean;
+    /**
+     * Application name (denormalized field)
+     */
     Application: string;
+    /**
+     * Entity name (denormalized field)
+     */
     Entity: string;
+    /**
+     * Base table name of the entity
+     */
     EntityBaseTable: string;
+    /**
+     * Code-friendly name of the entity
+     */
     EntityCodeName: string;
+    /**
+     * Class name of the entity
+     */
     EntityClassName: string;
+    /**
+     * Code-friendly name of the entity's base table
+     */
     EntityBaseTableCodeName: string;
     private _EntityInfo;
+    /**
+     * Gets the full entity metadata for the entity linked to this application.
+     * @returns {EntityInfo} The entity information object
+     */
     get EntityInfo(): EntityInfo;
     _setEntity(entity: EntityInfo): void;
     constructor(initData?: any);
 }
 /**
- * Information about an application
+ * Applications are used to group entities in the user interface for ease of user access.
+ * Provides organizational structure for presenting entities to users.
  */
 export declare class ApplicationInfo extends BaseInfo {
+    /**
+     * Unique identifier for the application
+     */
     ID: string;
+    /**
+     * Name of the application
+     */
     Name: string;
+    /**
+     * Description of the application
+     */
     Description: string;
+    /**
+     * CSS class information for the display icon for each application
+     */
     Icon: string;
+    /**
+     * If turned on, when a new user first uses the MJ Explorer app, the application records with this turned on will have this application included in their selected application list
+     */
     DefaultForNewUser: boolean;
+    /**
+     * Comma-delimited list of schema names where entities will be automatically added to the application when created in those schemas
+     */
     SchemaAutoAddNewEntities: string;
     private _ApplicationEntities;
+    /**
+     * Gets the list of entities that belong to this application with their display sequence.
+     * @returns {ApplicationEntityInfo[]} Array of application entity mappings
+     */
     get ApplicationEntities(): ApplicationEntityInfo[];
     private _ApplicationSettings;
+    /**
+     * Gets the configuration settings for this application.
+     * @returns {ApplicationSettingInfo[]} Array of key-value settings
+     */
     get ApplicationSettings(): ApplicationSettingInfo[];
     constructor(initData: any, md: IMetadataProvider);
 }

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

@@ -1 +1 @@
-{"version":3,"file":"applicationInfo.d.ts","sourceRoot":"","sources":["../../src/generic/applicationInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEjD,qBAAa,sBAAuB,SAAQ,QAAQ;IAChD,EAAE,EAAE,MAAM,CAAO;IACjB,eAAe,EAAE,MAAM,CAAO;IAC9B,IAAI,EAAE,MAAM,CAAO;IACnB,KAAK,EAAE,MAAM,CAAO;IACpB,QAAQ,EAAE,MAAM,CAAO;IACvB,cAAc,EAAE,IAAI,CAAO;IAC3B,cAAc,EAAE,IAAI,CAAO;gBAEd,QAAQ,GAAE,GAAU;CAIpC;AAED,qBAAa,qBAAsB,SAAQ,QAAQ;IAC/C,EAAE,EAAE,MAAM,CAAO;IACjB,eAAe,EAAE,MAAM,CAAO;IAC9B,QAAQ,EAAE,MAAM,CAAO;IACvB,QAAQ,EAAE,MAAM,CAAO;IACvB,iBAAiB,EAAE,OAAO,CAAO;IACjC,WAAW,EAAE,MAAM,CAAO;IAC1B,MAAM,EAAE,MAAM,CAAO;IACrB,eAAe,EAAE,MAAM,CAAO;IAC9B,cAAc,EAAE,MAAM,CAAO;IAC7B,eAAe,EAAE,MAAM,CAAO;IAC9B,uBAAuB,EAAE,MAAM,CAAO;IAEtC,OAAO,CAAC,WAAW,CAAmB;IACtC,IAAW,UAAU,IAAI,UAAU,CAElC;IAED,UAAU,CAAC,MAAM,EAAE,UAAU;gBAIhB,QAAQ,GAAE,GAAU;CAIpC;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;IACzC,EAAE,EAAE,MAAM,CAAO;IACjB,IAAI,EAAE,MAAM,CAAO;IACnB,WAAW,EAAE,MAAM,CAAO;IAC1B,IAAI,EAAE,MAAM,CAAO;IACnB,iBAAiB,EAAE,OAAO,CAAO;IACjC,wBAAwB,EAAE,MAAM,CAAO;IAEvC,OAAO,CAAC,oBAAoB,CAA8B;IAC1D,IAAW,mBAAmB,IAAI,qBAAqB,EAAE,CAExD;IAED,OAAO,CAAC,oBAAoB,CAA+B;IAC3D,IAAW,mBAAmB,IAAI,sBAAsB,EAAE,CAEzD;gBAEY,QAAQ,EAAE,GAAU,EAAE,EAAE,EAAE,iBAAiB;CAyB3D"}
+{"version":3,"file":"applicationInfo.d.ts","sourceRoot":"","sources":["../../src/generic/applicationInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEjD;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,QAAQ;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAO;IAEjB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAO;IAE9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAO;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAO;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAO;IAEvB;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAE3B;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;gBAEd,QAAQ,GAAE,GAAU;CAIpC;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,QAAQ;IAC/C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAO;IAEjB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAO;IAE9B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAO;IAEvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAO;IAEvB;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAO;IAEjC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAO;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAO;IAErB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAO;IAE9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAO;IAE7B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAO;IAE9B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAO;IAEtC,OAAO,CAAC,WAAW,CAAmB;IACtC;;;OAGG;IACH,IAAW,UAAU,IAAI,UAAU,CAElC;IAED,UAAU,CAAC,MAAM,EAAE,UAAU;gBAIhB,QAAQ,GAAE,GAAU;CAIpC;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAO;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAO;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAO;IAE1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAO;IAEnB;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAO;IAEjC;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAO;IAEvC,OAAO,CAAC,oBAAoB,CAA8B;IAC1D;;;OAGG;IACH,IAAW,mBAAmB,IAAI,qBAAqB,EAAE,CAExD;IAED,OAAO,CAAC,oBAAoB,CAA+B;IAC3D;;;OAGG;IACH,IAAW,mBAAmB,IAAI,sBAAsB,EAAE,CAEzD;gBAEY,QAAQ,EAAE,GAAU,EAAE,EAAE,EAAE,iBAAiB;CAyB3D"}

package/dist/generic/applicationInfo.js

@@ -2,21 +2,52 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApplicationInfo = exports.ApplicationEntityInfo = exports.ApplicationSettingInfo = void 0;
 const baseInfo_1 = require("./baseInfo");
+/**
+ * Stores configuration settings and preferences for applications, including key-value pairs for runtime parameters and user-specific customizations.
+ */
 class ApplicationSettingInfo extends baseInfo_1.BaseInfo {
     constructor(initData = null) {
         super();
+        /**
+         * Unique identifier for the application setting
+         */
         this.ID = null;
+        /**
+         * Name of the application this setting belongs to
+         */
         this.ApplicationName = null;
+        /**
+         * Name of the setting
+         */
         this.Name = null;
+        /**
+         * The setting value, can be simple text, numbers, booleans, or JSON for complex configuration objects
+         */
         this.Value = null;
+        /**
+         * Additional comments about the setting
+         */
         this.Comments = null;
+        /**
+         * Timestamp when the record was created
+         */
         this.__mj_CreatedAt = null;
+        /**
+         * Timestamp when the record was last updated
+         */
         this.__mj_UpdatedAt = null;
         this.copyInitData(initData);
     }
 }
 exports.ApplicationSettingInfo = ApplicationSettingInfo;
+/**
+ * List of entities within each application. An application can have any number of entities and an entity can be part of any number of applications.
+ */
 class ApplicationEntityInfo extends baseInfo_1.BaseInfo {
+    /**
+     * Gets the full entity metadata for the entity linked to this application.
+     * @returns {EntityInfo} The entity information object
+     */
     get EntityInfo() {
         return this._EntityInfo;
     }
@@ -25,16 +56,49 @@ class ApplicationEntityInfo extends baseInfo_1.BaseInfo {
     }
     constructor(initData = null) {
         super();
+        /**
+         * Unique identifier for the application entity relationship
+         */
         this.ID = null;
+        /**
+         * Name of the application
+         */
         this.ApplicationName = null;
+        /**
+         * ID of the entity linked to this application
+         */
         this.EntityID = null;
+        /**
+         * Display order of this entity within the application, lower numbers appear first in navigation and menus
+         */
         this.Sequence = null;
+        /**
+         * When set to true, the entity will be included by default for a new user when they first access the application in question
+         */
         this.DefaultForNewUser = null;
+        /**
+         * Application name (denormalized field)
+         */
         this.Application = null;
+        /**
+         * Entity name (denormalized field)
+         */
         this.Entity = null;
+        /**
+         * Base table name of the entity
+         */
         this.EntityBaseTable = null;
+        /**
+         * Code-friendly name of the entity
+         */
         this.EntityCodeName = null;
+        /**
+         * Class name of the entity
+         */
         this.EntityClassName = null;
+        /**
+         * Code-friendly name of the entity's base table
+         */
         this.EntityBaseTableCodeName = null;
         this._EntityInfo = null;
         this.copyInitData(initData);
@@ -42,22 +106,49 @@ class ApplicationEntityInfo extends baseInfo_1.BaseInfo {
 }
 exports.ApplicationEntityInfo = ApplicationEntityInfo;
 /**
- * Information about an application
+ * Applications are used to group entities in the user interface for ease of user access.
+ * Provides organizational structure for presenting entities to users.
  */
 class ApplicationInfo extends baseInfo_1.BaseInfo {
+    /**
+     * Gets the list of entities that belong to this application with their display sequence.
+     * @returns {ApplicationEntityInfo[]} Array of application entity mappings
+     */
     get ApplicationEntities() {
         return this._ApplicationEntities;
     }
+    /**
+     * Gets the configuration settings for this application.
+     * @returns {ApplicationSettingInfo[]} Array of key-value settings
+     */
     get ApplicationSettings() {
         return this._ApplicationSettings;
     }
     constructor(initData = null, md) {
         super();
+        /**
+         * Unique identifier for the application
+         */
         this.ID = null;
+        /**
+         * Name of the application
+         */
         this.Name = null;
+        /**
+         * Description of the application
+         */
         this.Description = null;
+        /**
+         * CSS class information for the display icon for each application
+         */
         this.Icon = null;
+        /**
+         * If turned on, when a new user first uses the MJ Explorer app, the application records with this turned on will have this application included in their selected application list
+         */
         this.DefaultForNewUser = null;
+        /**
+         * Comma-delimited list of schema names where entities will be automatically added to the application when created in those schemas
+         */
         this.SchemaAutoAddNewEntities = null;
         this._ApplicationEntities = [];
         this._ApplicationSettings = [];

package/dist/generic/applicationInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"applicationInfo.js","sourceRoot":"","sources":["../../src/generic/applicationInfo.ts"],"names":[],"mappings":";;;AAAA,yCAAqC;AAIrC,MAAa,sBAAuB,SAAQ,mBAAQ;IAShD,YAAa,WAAgB,IAAI;QAC7B,KAAK,EAAE,CAAA;QATX,OAAE,GAAW,IAAI,CAAA;QACjB,oBAAe,GAAW,IAAI,CAAA;QAC9B,SAAI,GAAW,IAAI,CAAA;QACnB,UAAK,GAAW,IAAI,CAAA;QACpB,aAAQ,GAAW,IAAI,CAAA;QACvB,mBAAc,GAAS,IAAI,CAAA;QAC3B,mBAAc,GAAS,IAAI,CAAA;QAIvB,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;IAC/B,CAAC;CACJ;AAbD,wDAaC;AAED,MAAa,qBAAsB,SAAQ,mBAAQ;IAc/C,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,WAAW,CAAA;IAC3B,CAAC;IAED,UAAU,CAAC,MAAkB;QACzB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAA;IAC7B,CAAC;IAED,YAAa,WAAgB,IAAI;QAC7B,KAAK,EAAE,CAAA;QAtBX,OAAE,GAAW,IAAI,CAAA;QACjB,oBAAe,GAAW,IAAI,CAAA;QAC9B,aAAQ,GAAW,IAAI,CAAA;QACvB,aAAQ,GAAW,IAAI,CAAA;QACvB,sBAAiB,GAAY,IAAI,CAAA;QACjC,gBAAW,GAAW,IAAI,CAAA;QAC1B,WAAM,GAAW,IAAI,CAAA;QACrB,oBAAe,GAAW,IAAI,CAAA;QAC9B,mBAAc,GAAW,IAAI,CAAA;QAC7B,oBAAe,GAAW,IAAI,CAAA;QAC9B,4BAAuB,GAAW,IAAI,CAAA;QAE9B,gBAAW,GAAe,IAAI,CAAA;QAWlC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;IAC/B,CAAC;CACJ;AA1BD,sDA0BC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,mBAAQ;IASzC,IAAW,mBAAmB;QAC1B,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACrC,CAAC;IAGD,IAAW,mBAAmB;QAC1B,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACrC,CAAC;IAED,YAAa,WAAgB,IAAI,EAAE,EAAqB;QACpD,KAAK,EAAE,CAAA;QAlBX,OAAE,GAAW,IAAI,CAAA;QACjB,SAAI,GAAW,IAAI,CAAA;QACnB,gBAAW,GAAW,IAAI,CAAA;QAC1B,SAAI,GAAW,IAAI,CAAA;QACnB,sBAAiB,GAAY,IAAI,CAAA;QACjC,6BAAwB,GAAW,IAAI,CAAA;QAE/B,yBAAoB,GAA4B,EAAE,CAAA;QAKlD,yBAAoB,GAA6B,EAAE,CAAA;QAOvD,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;QAC3B,IAAI,QAAQ,EAAE,CAAC;YACX,IAAI,EAAE,GAAG,QAAQ,CAAC,mBAAmB,IAAI,QAAQ,CAAC,oBAAoB,CAAC;YACvE,IAAI,EAAE,EAAE,CAAC;gBACL,MAAM,UAAU,GAAG,EAAE,CAAC,QAAQ,CAAC;gBAC/B,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC;gBAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBACjC,GAAG;oBACH,MAAM,GAAG,GAAG,IAAI,qBAAqB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;oBAC5C,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;oBAEnC,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;oBAC1D,IAAI,KAAK;wBACL,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;gBAC7B,CAAC;YACL,CAAC;YAED,IAAI,EAAE,GAAG,QAAQ,CAAC,mBAAmB,IAAI,QAAQ,CAAC,oBAAoB,CAAC;YACvE,IAAI,EAAE;gBACF,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/E,CAAC;IACL,CAAC;CAEJ;AA3CD,0CA2CC"}
+{"version":3,"file":"applicationInfo.js","sourceRoot":"","sources":["../../src/generic/applicationInfo.ts"],"names":[],"mappings":";;;AAAA,yCAAqC;AAIrC;;GAEG;AACH,MAAa,sBAAuB,SAAQ,mBAAQ;IAoChD,YAAa,WAAgB,IAAI;QAC7B,KAAK,EAAE,CAAA;QApCX;;WAEG;QACH,OAAE,GAAW,IAAI,CAAA;QAEjB;;WAEG;QACH,oBAAe,GAAW,IAAI,CAAA;QAE9B;;WAEG;QACH,SAAI,GAAW,IAAI,CAAA;QAEnB;;WAEG;QACH,UAAK,GAAW,IAAI,CAAA;QAEpB;;WAEG;QACH,aAAQ,GAAW,IAAI,CAAA;QAEvB;;WAEG;QACH,mBAAc,GAAS,IAAI,CAAA;QAE3B;;WAEG;QACH,mBAAc,GAAS,IAAI,CAAA;QAIvB,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;IAC/B,CAAC;CACJ;AAxCD,wDAwCC;AAED;;GAEG;AACH,MAAa,qBAAsB,SAAQ,mBAAQ;IAyD/C;;;OAGG;IACH,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,WAAW,CAAA;IAC3B,CAAC;IAED,UAAU,CAAC,MAAkB;QACzB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAA;IAC7B,CAAC;IAED,YAAa,WAAgB,IAAI;QAC7B,KAAK,EAAE,CAAA;QArEX;;WAEG;QACH,OAAE,GAAW,IAAI,CAAA;QAEjB;;WAEG;QACH,oBAAe,GAAW,IAAI,CAAA;QAE9B;;WAEG;QACH,aAAQ,GAAW,IAAI,CAAA;QAEvB;;WAEG;QACH,aAAQ,GAAW,IAAI,CAAA;QAEvB;;WAEG;QACH,sBAAiB,GAAY,IAAI,CAAA;QAEjC;;WAEG;QACH,gBAAW,GAAW,IAAI,CAAA;QAE1B;;WAEG;QACH,WAAM,GAAW,IAAI,CAAA;QAErB;;WAEG;QACH,oBAAe,GAAW,IAAI,CAAA;QAE9B;;WAEG;QACH,mBAAc,GAAW,IAAI,CAAA;QAE7B;;WAEG;QACH,oBAAe,GAAW,IAAI,CAAA;QAE9B;;WAEG;QACH,4BAAuB,GAAW,IAAI,CAAA;QAE9B,gBAAW,GAAe,IAAI,CAAA;QAelC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;IAC/B,CAAC;CACJ;AAzED,sDAyEC;AAED;;;GAGG;AACH,MAAa,eAAgB,SAAQ,mBAAQ;IAgCzC;;;OAGG;IACH,IAAW,mBAAmB;QAC1B,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACrC,CAAC;IAGD;;;OAGG;IACH,IAAW,mBAAmB;QAC1B,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACrC,CAAC;IAED,YAAa,WAAgB,IAAI,EAAE,EAAqB;QACpD,KAAK,EAAE,CAAA;QAjDX;;WAEG;QACH,OAAE,GAAW,IAAI,CAAA;QAEjB;;WAEG;QACH,SAAI,GAAW,IAAI,CAAA;QAEnB;;WAEG;QACH,gBAAW,GAAW,IAAI,CAAA;QAE1B;;WAEG;QACH,SAAI,GAAW,IAAI,CAAA;QAEnB;;WAEG;QACH,sBAAiB,GAAY,IAAI,CAAA;QAEjC;;WAEG;QACH,6BAAwB,GAAW,IAAI,CAAA;QAE/B,yBAAoB,GAA4B,EAAE,CAAA;QASlD,yBAAoB,GAA6B,EAAE,CAAA;QAWvD,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;QAC3B,IAAI,QAAQ,EAAE,CAAC;YACX,IAAI,EAAE,GAAG,QAAQ,CAAC,mBAAmB,IAAI,QAAQ,CAAC,oBAAoB,CAAC;YACvE,IAAI,EAAE,EAAE,CAAC;gBACL,MAAM,UAAU,GAAG,EAAE,CAAC,QAAQ,CAAC;gBAC/B,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC;gBAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBACjC,GAAG;oBACH,MAAM,GAAG,GAAG,IAAI,qBAAqB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;oBAC5C,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;oBAEnC,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;oBAC1D,IAAI,KAAK;wBACL,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;gBAC7B,CAAC;YACL,CAAC;YAED,IAAI,EAAE,GAAG,QAAQ,CAAC,mBAAmB,IAAI,QAAQ,CAAC,oBAAoB,CAAC;YACvE,IAAI,EAAE;gBACF,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/E,CAAC;IACL,CAAC;CAEJ;AA1ED,0CA0EC"}

package/dist/generic/baseInfo.d.ts

@@ -1,9 +1,24 @@
+/**
+ * Base class for all MemberJunction metadata info classes.
+ * Provides common functionality for copying initialization data and handling default values.
+ * All Info classes (EntityInfo, QueryInfo, etc.) extend this base class.
+ */
 export declare abstract class BaseInfo {
     /**
      * Primary Key
      */
     ID: any;
+    /**
+     * Copies initialization data from a plain object to the class instance.
+     * Only copies properties that already exist on the class to prevent creating new fields.
+     * Special handling for DefaultValue fields to extract actual values from SQL Server syntax.
+     * @param initData - The initialization data object
+     */
     protected copyInitData(initData: any): void;
+    /**
+     * Creates a new instance of the BaseInfo-derived class.
+     * @param initData - Optional initialization data to populate the instance
+     */
     constructor(initData?: any);
 }
 //# sourceMappingURL=baseInfo.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"baseInfo.d.ts","sourceRoot":"","sources":["../../src/generic/baseInfo.ts"],"names":[],"mappings":"AAEA,8BAAsB,QAAQ;IAC1B;;OAEG;IACH,EAAE,EAAE,GAAG,CAAO;IAEd,SAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,GAAG;gBAsBxB,QAAQ,GAAE,GAAU;CAKnC"}
+{"version":3,"file":"baseInfo.d.ts","sourceRoot":"","sources":["../../src/generic/baseInfo.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,8BAAsB,QAAQ;IAC1B;;OAEG;IACH,EAAE,EAAE,GAAG,CAAO;IAEd;;;;;OAKG;IACH,SAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,GAAG;IAsBpC;;;OAGG;gBACS,QAAQ,GAAE,GAAU;CAKnC"}

package/dist/generic/baseInfo.js

@@ -2,7 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseInfo = void 0;
 const util_1 = require("./util");
+/**
+ * Base class for all MemberJunction metadata info classes.
+ * Provides common functionality for copying initialization data and handling default values.
+ * All Info classes (EntityInfo, QueryInfo, etc.) extend this base class.
+ */
 class BaseInfo {
+    /**
+     * Copies initialization data from a plain object to the class instance.
+     * Only copies properties that already exist on the class to prevent creating new fields.
+     * Special handling for DefaultValue fields to extract actual values from SQL Server syntax.
+     * @param initData - The initialization data object
+     */
     copyInitData(initData) {
         if (initData) {
             // copy the properties from the init data to the new class instance we are constructing
@@ -24,6 +35,10 @@ class BaseInfo {
             }
         }
     }
+    /**
+     * Creates a new instance of the BaseInfo-derived class.
+     * @param initData - Optional initialization data to populate the instance
+     */
     constructor(initData = null) {
         /**
          * Primary Key

package/dist/generic/baseInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"baseInfo.js","sourceRoot":"","sources":["../../src/generic/baseInfo.ts"],"names":[],"mappings":";;;AAAA,iCAAmD;AAEnD,MAAsB,QAAQ;IAMhB,YAAY,CAAC,QAAa;QAChC,IAAI,QAAQ,EAAE,CAAC;YACX,uFAAuF;YACvF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACnC,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACnC,sEAAsE;gBACtE,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;oBACjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,cAAc,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;wBACvE,oHAAoH;wBACpH,qGAAqG;wBACrG,MAAM,YAAY,GAAW,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;wBAC/C,MAAM,WAAW,GAAW,IAAA,gCAAyB,EAAC,YAAY,CAAC,CAAC;wBACpE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC;oBAChC,CAAC;;wBAEG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC1C,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,YAAY,WAAgB,IAAI;QA3BhC;;WAEG;QACH,OAAE,GAAQ,IAAI,CAAA;QAyBV,IAAI,QAAQ,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAChC,CAAC;IACL,CAAC;CACJ;AAjCD,4BAiCC"}
+{"version":3,"file":"baseInfo.js","sourceRoot":"","sources":["../../src/generic/baseInfo.ts"],"names":[],"mappings":";;;AAAA,iCAAmD;AAEnD;;;;GAIG;AACH,MAAsB,QAAQ;IAM1B;;;;;OAKG;IACO,YAAY,CAAC,QAAa;QAChC,IAAI,QAAQ,EAAE,CAAC;YACX,uFAAuF;YACvF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACnC,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACnC,sEAAsE;gBACtE,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;oBACjC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,cAAc,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;wBACvE,oHAAoH;wBACpH,qGAAqG;wBACrG,MAAM,YAAY,GAAW,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;wBAC/C,MAAM,WAAW,GAAW,IAAA,gCAAyB,EAAC,YAAY,CAAC,CAAC;wBACpE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC;oBAChC,CAAC;;wBAEG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC1C,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,YAAY,WAAgB,IAAI;QArChC;;WAEG;QACH,OAAE,GAAQ,IAAI,CAAA;QAmCV,IAAI,QAAQ,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAChC,CAAC;IACL,CAAC;CACJ;AA3CD,4BA2CC"}

package/dist/generic/entityInfo.d.ts

@@ -33,6 +33,10 @@ export declare class RecordChange extends BaseInfo {
  * Information about the Entity Relationship between the Entity and the Related Entity - this class
  * maps to information in the Entity Relationships metadata entity.
  */
+/**
+ * Metadata about relationships between entities including display preferences for the UI.
+ * Defines foreign key relationships and how they should be represented in the user interface.
+ */
 export declare class EntityRelationshipInfo extends BaseInfo {
     ID: string;
     EntityID: string;
@@ -93,6 +97,10 @@ export declare class EntityUserPermissionInfo {
     CanUpdate: boolean;
     CanDelete: boolean;
 }
+/**
+ * Security settings for each entity.
+ * Controls which roles can perform create, read, update, and delete operations.
+ */
 export declare class EntityPermissionInfo extends BaseInfo {
     ID: string;
     EntityID: string;
@@ -142,6 +150,10 @@ export declare const EntityFieldValueListType: {
     readonly ListOrUserEntry: "ListOrUserEntry";
 };
 export type EntityFieldValueListType = typeof EntityFieldValueListType[keyof typeof EntityFieldValueListType];
+/**
+ * Defines allowed values for entity fields with value lists.
+ * Supports dropdowns, validations, and data integrity constraints.
+ */
 export declare class EntityFieldValueInfo extends BaseInfo {
     ID: string;
     EntityFieldID: string;
@@ -162,6 +174,10 @@ export type GeneratedFormSectionType = typeof GeneratedFormSectionType[keyof typ
 /**
  * Field information within an entity - object models data from the Entity Fields entity in the metadata
  */
+/**
+ * List of all fields within each entity with metadata about each field.
+ * Includes data types, relationships, defaults, and UI display preferences.
+ */
 export declare class EntityFieldInfo extends BaseInfo {
     ID: string;
     /**
@@ -420,6 +436,10 @@ export declare class EntityFieldInfo extends BaseInfo {
 /**
  * Entity Document Type Info object has information about the document types that exist across all entities. When Entity Documents are created they are associated with a document type.
  */
+/**
+ * Defines types of documents that can be generated from entity data.
+ * Supports various output formats for entity records.
+ */
 export declare class EntityDocumentTypeInfo extends BaseInfo {
     ID: string;
     Name: string;
@@ -431,6 +451,10 @@ export declare class EntityDocumentTypeInfo extends BaseInfo {
 /**
  * Settings allow you to store key/value pairs of information that can be used to configure the behavior of the entity.
  */
+/**
+ * Stores entity-specific configuration settings.
+ * Allows customization of how entities function within the system.
+ */
 export declare class EntitySettingInfo extends BaseInfo {
     ID: string;
     EntityID: string;
@@ -442,60 +466,193 @@ export declare class EntitySettingInfo extends BaseInfo {
     constructor(initData?: any);
 }
 /**
- * Metadata about an entity
+ * Catalog of all entities across all schemas.
+ * Contains comprehensive metadata about each entity including its database mappings, security settings, and UI preferences.
  */
 export declare class EntityInfo extends BaseInfo {
+    /**
+     * Unique identifier for the entity
+     */
     ID: string;
     /**
-     * Reserved for future use
+     * Reserved for future use - parent entity for hierarchical relationships
      */
     ParentID: string;
     /**
-     * Unique name of the entity
+     * Unique name of the entity used throughout the system
      */
     Name: string;
+    /**
+     * Optional suffix appended to entity names for display purposes
+     */
     NameSuffix: string;
+    /**
+     * Detailed description of the entity's purpose and contents
+     */
     Description: string;
+    /**
+     * The underlying database table name this entity maps to
+     */
     BaseTable: string;
+    /**
+     * The database view used as a "wrapper" for accessing this entity's data
+     */
     BaseView: string;
+    /**
+     * Whether the base view is generated by CodeGen (true) or manually created (false)
+     */
     BaseViewGenerated: boolean;
+    /**
+     * Database schema that contains this entity's table and view
+     */
     SchemaName: string;
+    /**
+     * If true, this is a virtual entity not backed by a physical database table
+     */
     VirtualEntity: boolean;
+    /**
+     * Whether to track all changes to records in the RecordChange table
+     */
     TrackRecordChanges: boolean;
+    /**
+     * Whether to audit when users access records from this entity
+     */
     AuditRecordAccess: boolean;
+    /**
+     * Whether to audit when views are run against this entity
+     */
     AuditViewRuns: boolean;
+    /**
+     * Whether this entity is available through the GraphQL API
+     */
     IncludeInAPI: boolean;
+    /**
+     * If true, allows querying all rows without pagination limits via API
+     */
     AllowAllRowsAPI: boolean;
+    /**
+     * Global flag controlling whether records can be updated via API
+     */
     AllowUpdateAPI: boolean;
+    /**
+     * Global flag controlling whether records can be created via API
+     */
     AllowCreateAPI: boolean;
+    /**
+     * Global flag controlling whether records can be deleted via API
+     */
     AllowDeleteAPI: boolean;
+    /**
+     * If true, uses a custom resolver for GraphQL operations instead of standard CRUD
+     */
     CustomResolverAPI: boolean;
+    /**
+     * Whether users can search this entity through the search API
+     */
     AllowUserSearchAPI: boolean;
+    /**
+     * Whether full-text search is enabled for this entity
+     */
     FullTextSearchEnabled: boolean;
+    /**
+     * Name of the SQL Server full-text catalog used for searching
+     */
     FullTextCatalog: string;
+    /**
+     * Whether the full-text catalog is generated by CodeGen
+     */
     FullTextCatalogGenerated: boolean;
+    /**
+     * Name of the full-text index on this entity
+     */
     FullTextIndex: string;
+    /**
+     * Whether the full-text index is generated by CodeGen
+     */
     FullTextIndexGenerated: boolean;
+    /**
+     * Name of the function used for full-text searching
+     */
     FullTextSearchFunction: string;
+    /**
+     * Whether the full-text search function is generated by CodeGen
+     */
     FullTextSearchFunctionGenerated: boolean;
+    /**
+     * Maximum number of rows to return in user views to prevent performance issues
+     */
     UserViewMaxRows: number;
+    /**
+     * Name of the stored procedure for creating records
+     */
     spCreate: string;
+    /**
+     * Name of the stored procedure for updating records
+     */
     spUpdate: string;
+    /**
+     * Name of the stored procedure for deleting records
+     */
     spDelete: string;
+    /**
+     * Whether the create stored procedure is generated by CodeGen
+     */
     spCreateGenerated: boolean;
+    /**
+     * Whether the update stored procedure is generated by CodeGen
+     */
     spUpdateGenerated: boolean;
+    /**
+     * Whether the delete stored procedure is generated by CodeGen
+     */
     spDeleteGenerated: boolean;
+    /**
+     * Whether to automatically delete related records when a parent is deleted
+     */
     CascadeDeletes: boolean;
+    /**
+     * Type of delete operation: Hard (physical delete) or Soft (mark as deleted)
+     */
     DeleteType: 'Hard' | 'Soft';
+    /**
+     * Whether records in this entity can be merged together
+     */
     AllowRecordMerge: boolean;
+    /**
+     * Name of the stored procedure used for matching/duplicate detection
+     */
     spMatch: string;
+    /**
+     * Default display type for relationships: Search (type-ahead) or Dropdown
+     */
     RelationshipDefaultDisplayType: 'Search' | 'Dropdown';
+    /**
+     * Whether the user form for this entity is generated by CodeGen
+     */
     UserFormGenerated: boolean;
+    /**
+     * Name of the TypeScript subclass for this entity if custom behavior is needed
+     */
     EntityObjectSubclassName: string;
+    /**
+     * Import statement for the entity's TypeScript subclass
+     */
     EntityObjectSubclassImport: string;
+    /**
+     * Field name that contains the preferred communication method (email, phone, etc.)
+     */
     PreferredCommunicationField: string;
+    /**
+     * CSS class or icon identifier for displaying this entity in the UI
+     */
     Icon: string;
+    /**
+     * Date and time when this entity was created
+     */
     __mj_CreatedAt: Date;
+    /**
+     * Date and time when this entity was last updated
+     */
     __mj_UpdatedAt: Date;
     /**
     * * Field Name: ScopeDefault
@@ -601,11 +758,35 @@ export declare class EntityInfo extends BaseInfo {
      * Returns an array of all fields that are part of the primary key for the entity. If the entity has a single primary key, the array will have a single element.
      */
     get PrimaryKeys(): EntityFieldInfo[];
+    /**
+     * Returns an array of all fields that have unique constraints on them.
+     * @returns {EntityFieldInfo[]} Array of fields with unique constraints
+     */
     get UniqueKeys(): EntityFieldInfo[];
+    /**
+     * Returns an array of all fields that are foreign keys to other entities.
+     * @returns {EntityFieldInfo[]} Array of foreign key fields
+     */
     get ForeignKeys(): EntityFieldInfo[];
+    /**
+     * Gets all fields for this entity with their complete metadata.
+     * @returns {EntityFieldInfo[]} Array of all entity fields
+     */
     get Fields(): EntityFieldInfo[];
+    /**
+     * Gets all relationships where other entities reference this entity.
+     * @returns {EntityRelationshipInfo[]} Array of entity relationships
+     */
     get RelatedEntities(): EntityRelationshipInfo[];
+    /**
+     * Gets the security permissions for this entity by role.
+     * @returns {EntityPermissionInfo[]} Array of permission settings
+     */
     get Permissions(): EntityPermissionInfo[];
+    /**
+     * Gets custom configuration settings for this entity.
+     * @returns {EntitySettingInfo[]} Array of entity-specific settings
+     */
     get Settings(): EntitySettingInfo[];
     private static __createdAtFieldName;
     private static __updatedAtFieldName;