@memberjunction/sqlserver-dataprovider 0.9.1

package/dist/SQLServerDataProvider.d.ts

@@ -0,0 +1,89 @@
+/**************************************************************************************************************
+* The SQLServerDataProvider provides a data provider for the entities framework that uses SQL Server directly
+* In practice - this FILE will NOT exist in the entities library, we need to move to its own separate project
+* so it is only included by the consumer of the entities library if they want to use it.
+**************************************************************************************************************/
+import { BaseEntity, IEntityDataProvider, IMetadataProvider, IRunViewProvider, ProviderConfigDataBase, RunViewResult, EntityInfo, ApplicationInfo, RunViewParams, ProviderBase, EntityDataProviderType, UserInfo, RoleInfo, RecordChange, UserRoleInfo, ILocalStorageProvider, RowLevelSecurityFilterInfo, AuditLogTypeInfo, AuthorizationInfo, TransactionGroupBase, EntitySaveOptions, UserViewEntityBase, RunReportParams, DatasetItemFilterType, DatasetResultType, DatasetStatusResultType, EntityRecordNameInput, EntityRecordNameResult, IRunReportProvider, RunReportResult } from "@memberjunction/core";
+export declare class SQLServerProviderConfigData extends ProviderConfigDataBase {
+    get DataSource(): any;
+    get CurrentUserEmail(): string;
+    get CheckRefreshIntervalSeconds(): number;
+    constructor(dataSource: any, currentUserEmail: string, MJCoreSchemaName?: string, checkRefreshIntervalSeconds?: number, includeSchemas?: string[], excludeSchemas?: string[]);
+}
+export declare class SQLServerDataProvider extends ProviderBase implements IEntityDataProvider, IMetadataProvider, IRunViewProvider, IRunReportProvider {
+    private _dataSource;
+    private _currentUserEmail;
+    private _localStorageProvider;
+    private _bAllowRefresh;
+    get ConfigData(): SQLServerProviderConfigData;
+    Config(configData: SQLServerProviderConfigData): Promise<boolean>;
+    protected AllowRefresh(): boolean;
+    /**************************************************************************/
+    /**************************************************************************/
+    RunReport(params: RunReportParams, contextUser?: UserInfo): Promise<RunReportResult>;
+    /**************************************************************************/
+    /**************************************************************************/
+    /**************************************************************************/
+    /**************************************************************************/
+    RunView(params: RunViewParams, contextUser?: UserInfo): Promise<RunViewResult>;
+    protected validateUserProvidedSQLClause(clause: string): boolean;
+    protected getRunTimeViewFieldString(params: RunViewParams, viewEntity: UserViewEntityBase): string;
+    protected getRunTimeViewFieldArray(params: RunViewParams, viewEntity: UserViewEntityBase): string[];
+    protected executeSQLForUserViewRunLogging(viewId: number, entityBaseView: string, whereSQL: string, orderBySQL: string, user: UserInfo): Promise<{
+        executeViewSQL: string;
+        runID: number;
+    }>;
+    protected createViewUserSearchSQL(entityInfo: EntityInfo, userSearchString: string): string;
+    createAuditLogRecord(user: UserInfo, authorizationName: string | null, auditLogTypeName: string, status: string, details: string | null, entityId: number, recordId: number | null, auditLogDescription: string | null): Promise<any>;
+    protected CheckUserReadPermissions(entityName: string, contextUser: UserInfo): void;
+    /**************************************************************************/
+    /**************************************************************************/
+    /**************************************************************************/
+    /**************************************************************************/
+    get ProviderType(): EntityDataProviderType;
+    GetRecordFavoriteStatus(userId: number, entityName: string, recordId: number): Promise<boolean>;
+    GetRecordFavoriteID(userId: number, entityName: string, recordId: number): Promise<number | null>;
+    SetRecordFavoriteStatus(userId: number, entityName: string, recordId: number, isFavorite: boolean, contextUser: UserInfo): Promise<void>;
+    GetRecordChanges(entityName: string, recordId: number): Promise<RecordChange[]>;
+    protected GetSaveSQL(entity: BaseEntity, bNewRecord: boolean, spName: string, user: UserInfo): string;
+    protected GetEntityAIActions(entityInfo: EntityInfo, before: boolean): any;
+    protected HandleEntityAIActions(entity: BaseEntity, before: boolean, user: UserInfo): Promise<void>;
+    Save(entity: BaseEntity, user: UserInfo, options: EntitySaveOptions): Promise<{}>;
+    private getAllEntityColumnsSQL;
+    private generateSPParams;
+    private generateSingleSPParam;
+    protected packageSPParam(paramValue: any, quoteString: string): string;
+    protected GetLogRecordChangeSQL(newData: any, oldData: any, entityName: string, recordID: string, entityInfo: EntityInfo, user: UserInfo): string;
+    protected LogRecordChange(newData: any, oldData: any, entityName: string, recordID: number, entityInfo: EntityInfo, user: UserInfo): Promise<any>;
+    protected CreateUserDescription(changesObject: any, maxValueLength?: number): string;
+    protected trimString(value: any, maxLength: number, trailingChars: string): any;
+    protected escapeQuotesInProperties(obj: any, quoteToEscape: string): any;
+    protected DiffObjects(oldData: any, newData: any, entityInfo: EntityInfo, quoteToEscape: string): any;
+    Load(entity: BaseEntity, RecordID: number, EntityRelationshipsToLoad: string[], user: UserInfo): Promise<{}>;
+    protected GetDeleteSQL(entity: BaseEntity, user: UserInfo): string;
+    Delete(entity: BaseEntity, user: UserInfo): Promise<boolean>;
+    /**************************************************************************/
+    /**************************************************************************/
+    /**************************************************************************/
+    /**************************************************************************/
+    GetDatasetByName(datasetName: string, itemFilters?: DatasetItemFilterType[]): Promise<DatasetResultType>;
+    GetDatasetStatusByName(datasetName: string, itemFilters?: DatasetItemFilterType[]): Promise<DatasetStatusResultType>;
+    protected GetApplicationMetadata(): Promise<ApplicationInfo[]>;
+    protected GetAuditLogTypeMetadata(): Promise<AuditLogTypeInfo[]>;
+    protected GetUserMetadata(): Promise<UserInfo[]>;
+    protected GetAuthorizationMetadata(): Promise<AuthorizationInfo[]>;
+    protected GetCurrentUser(): Promise<UserInfo>;
+    protected GetCurrentUserMetadata(): Promise<UserInfo>;
+    protected GetRoleMetadata(): Promise<RoleInfo[]>;
+    protected GetUserRoleMetadata(): Promise<UserRoleInfo[]>;
+    protected GetRowLevelSecurityFilterMetadata(): Promise<RowLevelSecurityFilterInfo[]>;
+    protected ExecuteSQL(query: string, parameters?: any): Promise<any>;
+    get LocalStorageProvider(): ILocalStorageProvider;
+    GetEntityRecordNames(info: EntityRecordNameInput[]): Promise<EntityRecordNameResult[]>;
+    GetEntityRecordName(entityName: string, recordId: number): Promise<string>;
+    protected GetEntityRecordNameSQL(entityName: string, recordId: number): string;
+    CreateTransactionGroup(): Promise<TransactionGroupBase>;
+    /**************************************************************************/
+    /**************************************************************************/
+    protected get Metadata(): IMetadataProvider;
+}