@memberjunction/core 0.9.0

package/dist/generic/baseInfo.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseInfo = void 0;
+class BaseInfo {
+    constructor() {
+        /**
+         * Primary Key
+         */
+        this.ID = null;
+    }
+    copyInitData(initData) {
+        if (initData) {
+            // copy the properties from the init data to the new class instance we are constructing
+            const keys = Object.keys(initData);
+            const thisKeys = Object.keys(this);
+            for (let j = 0; j < keys.length; j++) {
+                // make sure it is one of our keys, we don't want to create NEW fields
+                if (thisKeys.indexOf(keys[j]) >= 0) {
+                    if (keys[j].trim().toLowerCase() === 'defaultvalue' && initData[keys[j]])
+                        // strip parens from default value from the DB, if they exist, for example defaults might be ((1)) or (getdate())                    
+                        this[keys[j]] = this.stripContainingParens(initData[keys[j]]);
+                    else
+                        this[keys[j]] = initData[keys[j]];
+                }
+            }
+        }
+    }
+    stripContainingParens(value) {
+        if (value.startsWith('(') && value.endsWith(')')) {
+            // recursive call so if we have ((0)) we keep stripping parens until we get to inner value
+            // could be something like (getdate()) in which case we'll only strip the SYMMENTRIC parens
+            return this.stripContainingParens(value.substring(1, value.length - 1));
+        }
+        return value;
+    }
+}
+exports.BaseInfo = BaseInfo;
+//# sourceMappingURL=baseInfo.js.map

package/dist/generic/baseInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseInfo.js","sourceRoot":"","sources":["../../src/generic/baseInfo.ts"],"names":[],"mappings":";;;AAAA,MAAsB,QAAQ;IAA9B;QACI;;WAEG;QACH,OAAE,GAAW,IAAI,CAAA;IA4BrB,CAAC;IA1Ba,YAAY,CAAC,QAAa;QAChC,IAAI,QAAQ,EAAE;YACV,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;gBAClC,sEAAsE;gBACtE,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE;oBAChC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,cAAc,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;wBACpE,qIAAqI;wBACrI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;;wBAE9D,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;iBACzC;aACJ;SACJ;IACL,CAAC;IAES,qBAAqB,CAAC,KAAa;QACzC,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC9C,0FAA0F;YAC1F,2FAA2F;YAC3F,OAAO,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;SAC3E;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;CACJ;AAhCD,4BAgCC"}

package/dist/generic/entityInfo.d.ts

@@ -0,0 +1,340 @@
+import { BaseInfo } from "./baseInfo";
+import { RunViewParams } from "../views/runView";
+import { BaseEntity } from "./baseEntity";
+import { RowLevelSecurityFilterInfo, UserInfo } from "./securityInfo";
+/**
+ * The possible status values for a record change
+ */
+export declare enum RecordChangeStatus {
+    Pending = 1,
+    Complete = 2,
+    Error = 3
+}
+/**
+ * Record Change object has information on a change to a record in the Record Changes entity
+ */
+export declare class RecordChange extends BaseInfo {
+    EntityID: number;
+    RecordID: number;
+    ChangedAt: Date;
+    ChangesJSON: string;
+    ChangesDescription: string;
+    FullRecordJSON: string;
+    Status: string;
+    get StatusValue(): RecordChangeStatus;
+    get Changes(): any;
+    get FullRecord(): any;
+    constructor(initData: any);
+}
+/**
+ * Information about the Entity Relationship between the Entity and the Related Entity - this class
+ * maps to information in the Entity Relationships metadata entity.
+ */
+export declare class EntityRelationshipInfo extends BaseInfo {
+    EntityID: number;
+    RelatedEntityID: number;
+    BundleInAPI: boolean;
+    IncludeInParentAllQuery: boolean;
+    Type: string;
+    EntityKeyField: string;
+    RelatedEntityJoinField: string;
+    JoinView: string;
+    JoinEntityJoinField: string;
+    JoinEntityInverseJoinField: string;
+    DisplayInForm: boolean;
+    DisplayName: string;
+    DisplayUserViewGUID: string;
+    CreatedAt: Date;
+    UpdatedAt: Date;
+    Entity: string;
+    EntityBaseTable: string;
+    EntityBaseView: string;
+    RelatedEntity: string;
+    RelatedEntityBaseTable: string;
+    RelatedEntityBaseView: string;
+    RelatedEntityCodeName: string;
+    RelatedEntityClassName: string;
+    RelatedEntityBaseTableCodeName: string;
+    constructor(initData: any);
+}
+export declare enum EntityPermissionType {
+    Read = 1,
+    Create = 2,
+    Update = 3,
+    Delete = 4
+}
+export declare class EntityUserPermissionInfo {
+    Entity: EntityInfo;
+    User: UserInfo;
+    CanCreate: boolean;
+    CanRead: boolean;
+    CanUpdate: boolean;
+    CanDelete: boolean;
+}
+export declare class EntityPermissionInfo extends BaseInfo {
+    EntityID: number;
+    RoleName: string;
+    CanCreate: boolean;
+    CanRead: boolean;
+    CanUpdate: boolean;
+    CanDelete: boolean;
+    ReadRLSFilterID: number;
+    CreateRLSFilterID: number;
+    UpdateRLSFilterID: number;
+    DeleteRLSFilterID: number;
+    CreatedAt: Date;
+    UpdatedAt: Date;
+    Entity: string;
+    RoleSQLName: string;
+    ReadRLSFilter: string;
+    CreateRLSFilter: string;
+    UpdateRLSFilter: string;
+    DeleteRLSFilter: string;
+    get CreateRLSFilterObject(): RowLevelSecurityFilterInfo;
+    get ReadRLSFilterObject(): RowLevelSecurityFilterInfo;
+    get UpdateRLSFilterObject(): RowLevelSecurityFilterInfo;
+    get DeleteRLSFilterObject(): RowLevelSecurityFilterInfo;
+    RLSFilter(type: EntityPermissionType): RowLevelSecurityFilterInfo;
+    constructor(initData: any);
+}
+export declare enum EntityFieldTSType {
+    String = 1,
+    Number = 2,
+    Date = 3,
+    Boolean = 4
+}
+export declare enum EntityFieldValueListType {
+    "None" = 0,
+    "List" = 1,
+    "ListOrUserEntry" = 2
+}
+export declare class EntityFieldValueInfo extends BaseInfo {
+    EntityID: number;
+    EntityFieldName: string;
+    Sequence: number;
+    Value: string;
+    Code: string;
+    Description: string;
+    CreatedAt: Date;
+    UpdatedAt: Date;
+    constructor(initData: any);
+}
+export declare enum GeneratedFormSectionType {
+    Top = 0,
+    Details = 1,
+    Category = 2
+}
+/**
+ * Field information within an entity - object models data from the Entity Fields entity in the metadata
+ */
+export declare class EntityFieldInfo extends BaseInfo {
+    /**
+     * Foreign key to the Entities entity.
+     */
+    EntityID: number;
+    /**
+     * The sequence of the field within the entity, typically the intended display order
+     */
+    Sequence: number;
+    Name: string;
+    /**
+     * Optional property that provides the display name for the field, if null, use the Name property.
+     * The DisplayNameOrName() method is a helper function that does this for you with a single method call.
+     */
+    DisplayName: string;
+    Description: string;
+    Category: string;
+    Type: string;
+    Length: number;
+    Precision: number;
+    Scale: number;
+    AllowsNull: boolean;
+    DefaultValue: string;
+    AutoIncrement: boolean;
+    ValueListType: string;
+    ExtendedType: string;
+    DefaultInView: boolean;
+    ViewCellTemplate: string;
+    DefaultColumnWidth: number;
+    AllowUpdateAPI: boolean;
+    AllowUpdateInView: boolean;
+    IncludeInUserSearchAPI: boolean;
+    FullTextSearchEnabled: boolean;
+    UserSearchParamFormatAPI: string;
+    IncludeInGeneratedForm: boolean;
+    GeneratedFormSection: string;
+    IsVirtual: boolean;
+    IsNameField: boolean;
+    RelatedEntityID: number;
+    RelatedEntityFieldName: string;
+    IncludeRelatedEntityNameFieldInBaseView: boolean;
+    RelatedEntityNameFieldMap: string;
+    CreatedAt: Date;
+    UpdatedAt: Date;
+    Entity: string;
+    SchemaName: string;
+    BaseTable: string;
+    BaseView: string;
+    EntityCodeName: string;
+    EntityClassName: string;
+    RelatedEntity: string;
+    RelatedEntitySchemaName: string;
+    RelatedEntityBaseTable: string;
+    RelatedEntityBaseView: string;
+    RelatedEntityCodeName: string;
+    RelatedEntityClassName: string;
+    IsFloat: boolean;
+    _RelatedEntityTableAlias: string;
+    _RelatedEntityNameFieldIsVirtual: boolean;
+    _EntityFieldValues: EntityFieldValueInfo[];
+    _RelatedEntityNameFieldMap: string;
+    get EntityFieldValues(): EntityFieldValueInfo[];
+    /**
+     * Returns the ValueListType using the EntityFieldValueListType enum.
+     */
+    get ValueListTypeEnum(): EntityFieldValueListType;
+    get GeneratedFormSectionType(): GeneratedFormSectionType;
+    /**
+     * Provides the TypeScript type for a given Entity Field. This is useful to map
+     * a wide array of database types to a narrower set of TypeScript types.
+     */
+    get TSType(): EntityFieldTSType;
+    /**
+     * Returns a string with the full SQL data type that combines, as appropriate, Type, Length, Precision and Scale where these attributes are relevant to the Type
+     */
+    get SQLFullType(): string;
+    get MaxLength(): number;
+    get ReadOnly(): boolean;
+    /**
+     * Returns the DisplayName if it exists, otherwise returns the Name.
+     */
+    get DisplayNameOrName(): string;
+    FormatValue(value: any, decimals?: number, currency?: string): string;
+    constructor(initData?: any);
+}
+/**
+ * Metadata about an entity
+ */
+export declare class EntityInfo extends BaseInfo {
+    /**
+     * Reserved for future use
+     */
+    ParentID: number;
+    /**
+     * Unique name of the entity
+     */
+    Name: string;
+    Description: string;
+    BaseTable: string;
+    BaseView: string;
+    BaseViewGenerated: boolean;
+    SchemaName: string;
+    VirtualEntity: boolean;
+    TrackRecordChanges: boolean;
+    AuditRecordAccess: boolean;
+    AuditViewRuns: boolean;
+    IncludeInAPI: boolean;
+    AllowAllRowsAPI: boolean;
+    AllowUpdateAPI: boolean;
+    AllowCreateAPI: boolean;
+    AllowDeleteAPI: boolean;
+    CustomResolverAPI: boolean;
+    AllowUserSearchAPI: boolean;
+    FullTextSearchEnabled: boolean;
+    FullTextCatalog: string;
+    FullTextCatalogGenerated: boolean;
+    FullTextIndex: string;
+    FullTextIndexGenerated: boolean;
+    FullTextSearchFunction: string;
+    FullTextSearchFunctionGenerated: boolean;
+    UserViewMaxRows: number;
+    spCreate: string;
+    spUpdate: string;
+    spDelete: string;
+    spCreateGenerated: boolean;
+    spUpdateGenerated: boolean;
+    spDeleteGenerated: boolean;
+    CascadeDeletes: boolean;
+    UserFormGenerated: boolean;
+    EntityObjectSubclassName: string;
+    EntityObjectSubclassImport: string;
+    CreatedAt: Date;
+    UpdatedAt: Date;
+    /**
+     * CodeName is a unique name that can be used for various programatic purposes, singular version of the entity name but modified from entity name in some cases to remove whitespace and prefix with _ in the event that the entity name begins with a number or other non-alpha character
+     */
+    CodeName: string;
+    ClassName: string;
+    BaseTableCodeName: string;
+    ParentEntity: number;
+    ParentBaseTable: string;
+    ParentBaseView: string;
+    private _Fields;
+    private _RelatedEntities;
+    private _Permissions;
+    _hasIdField: boolean;
+    _virtualCount: number;
+    _manyToManyCount: number;
+    _oneToManyCount: number;
+    _floatCount: number;
+    get Fields(): EntityFieldInfo[];
+    get RelatedEntities(): EntityRelationshipInfo[];
+    get Permissions(): EntityPermissionInfo[];
+    /**
+     * Returns the EntityField object for the Field that has IsNameField set to true. If multiple fields have IsNameField on, the function will return the first field (by sequence) that matches. If no fields match, null is returned
+     */
+    get NameField(): EntityFieldInfo | null;
+    /**
+     * Returns the Permissions for this entity for a given user, based on the roles the user is part of
+     * @param user
+     * @returns
+     */
+    GetUserPermisions(user: UserInfo): EntityUserPermissionInfo;
+    /**
+     * Determines if a given user, for a given permission type, is exempt from RowLevelSecurity or not
+     * @param user
+     * @param type
+     * @returns
+     */
+    UserExemptFromRowLevelSecurity(user: UserInfo, type: EntityPermissionType): boolean;
+    /**
+     * Returns RLS security info attributes for a given user and permission type
+     * @param user
+     * @param type
+     * @returns
+     */
+    GetUserRowLevelSecurityInfo(user: UserInfo, type: EntityPermissionType): RowLevelSecurityFilterInfo[];
+    /**
+     * Generates a where clause for SQL filtering for a given entity for a given user and permission type. If there is no RLS for a given entity or the user is exempt from RLS for the entity, a blank string is returned.
+     * @param user
+     * @param type
+     * @param returnPrefix
+     * @returns
+     */
+    GetUserRowLevelSecurityWhereClause(user: UserInfo, type: EntityPermissionType, returnPrefix: string): string;
+    /**
+     * Returns a RunViewParams object that is setup to filter the related entity for the provided record
+     * @param record
+     * @param relationship
+     * @param filter
+     * @returns
+     */
+    static BuildRelationshipViewParams(record: BaseEntity, relationship: EntityRelationshipInfo, filter?: string): RunViewParams;
+    constructor(initData?: any);
+    private prepareSpecialFields;
+}
+export declare enum ValidationErrorType {
+    Failure = 0,
+    Warning = 1
+}
+export declare class ValidationErrorInfo {
+    Source: string;
+    Message: string;
+    Value: string;
+    Type: ValidationErrorType;
+    constructor(Source: string, Message: string, Value: string, Type?: ValidationErrorType);
+}
+export declare class ValidationResult {
+    Success: boolean;
+    Errors: ValidationErrorInfo[];
+}