@memberjunction/graphql-dataprovider 1.5.3 → 1.6.1

package/dist-browser/config.d.ts

@@ -0,0 +1,2 @@
+import { GraphQLDataProvider, GraphQLProviderConfigData } from "./graphQLDataProvider";
+export declare function setupGraphQLClient(config: GraphQLProviderConfigData): Promise<GraphQLDataProvider>;

package/dist-browser/config.js

@@ -0,0 +1,18 @@
+import { RunReport, BaseEntity, Metadata, RunView, RunQuery } from "@memberjunction/core";
+import { GraphQLDataProvider } from "./graphQLDataProvider";
+import { MJGlobal, MJEventType } from "@memberjunction/global";
+export async function setupGraphQLClient(config) {
+    // Set the provider for all entities to be GraphQL in this project, can use a different provider in other situations....
+    const provider = new GraphQLDataProvider();
+    // BaseEntity + Metadata share the same GraphQLDataProvider instance
+    BaseEntity.Provider = provider;
+    Metadata.Provider = provider;
+    RunView.Provider = provider;
+    RunReport.Provider = provider;
+    RunQuery.Provider = provider;
+    await provider.Config(config);
+    // fire off the logged in event if we get here
+    MJGlobal.Instance.RaiseEvent({ event: MJEventType.LoggedIn, eventCode: null, component: this, args: null });
+    return provider;
+}
+//# sourceMappingURL=config.js.map

package/dist-browser/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,mBAAmB,EAA6B,MAAM,uBAAuB,CAAC;AACvF,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE/D,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,MAAiC;IACtE,wHAAwH;IACxH,MAAM,QAAQ,GAAG,IAAI,mBAAmB,EAAE,CAAA;IAE1C,oEAAoE;IACpE,UAAU,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC9B,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC5B,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC3B,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC7B,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAE5B,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAE9B,8CAA8C;IAC9C,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAE5G,OAAO,QAAQ,CAAC;AACpB,CAAC"}

package/dist-browser/graphQLDataProvider.d.ts

@@ -0,0 +1,122 @@
+/**************************************************************************************************************
+ * The graphQLDataProvider provides a data provider for the entities framework that uses GraphQL to communicate
+ * with the server.
+ * 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, RunViewParams, ProviderBase, ProviderType, UserInfo, RecordChange, ILocalStorageProvider, EntitySaveOptions, TransactionGroupBase, DatasetItemFilterType, DatasetResultType, DatasetStatusResultType, EntityRecordNameInput, EntityRecordNameResult, IRunReportProvider, RunReportResult, RunReportParams, RecordDependency, RecordMergeRequest, RecordMergeResult, IRunQueryProvider, RunQueryResult, PotentialDuplicateRequest, PotentialDuplicateResponse, CompositeKey, EntityDeleteOptions, RunQueryParams, KeyValuePair } from "@memberjunction/core";
+import { UserViewEntityExtended } from '@memberjunction/core-entities';
+import { GraphQLClient } from 'graphql-request';
+import { Observable } from 'rxjs';
+export type RefreshTokenFunction = () => Promise<string>;
+export declare class GraphQLProviderConfigData extends ProviderConfigDataBase {
+    /**
+     * Token is the JWT token that is used to authenticate the user with the server
+     */
+    get Token(): string;
+    set Token(token: string);
+    /**
+     * URL is the URL to the GraphQL endpoint
+     */
+    get URL(): string;
+    /**
+     * WSURL is the URL to the GraphQL websocket endpoint. This is used for subscriptions, if you are not using subscriptions, you can pass in a blank string for this
+     */
+    get WSURL(): string;
+    /**
+     * RefreshTokenFunction is a function that can be called by the GraphQLDataProvider whenever it receives an exception that the JWT it has already is expired
+     */
+    get RefreshTokenFunction(): RefreshTokenFunction;
+    /**
+     *
+     * @param token Token is the JWT token that is used to authenticate the user with the server
+     * @param url the URL to the GraphQL endpoint
+     * @param wsurl the URL to the GraphQL websocket endpoint. This is used for subscriptions, if you are not using subscriptions, you can pass in a blank string for this
+     * @param refreshTokenFunction is a function that can be called by the GraphQLDataProvider whenever it receives an exception that the JWT it has already is expired
+     * @param MJCoreSchemaName the name of the MJ Core schema, if it is not the default name of __mj
+     * @param includeSchemas optional, an array of schema names to include in the metadata. If not passed, all schemas are included
+     * @param excludeSchemas optional, an array of schema names to exclude from the metadata. If not passed, no schemas are excluded
+     */
+    constructor(token: string, url: string, wsurl: string, refreshTokenFunction: RefreshTokenFunction, MJCoreSchemaName?: string, includeSchemas?: string[], excludeSchemas?: string[]);
+}
+export declare class GraphQLDataProvider extends ProviderBase implements IEntityDataProvider, IMetadataProvider, IRunViewProvider, IRunReportProvider, IRunQueryProvider {
+    private static _client;
+    private static _configData;
+    private static _sessionId;
+    get ConfigData(): GraphQLProviderConfigData;
+    GenerateUUID(): string;
+    Config(configData: GraphQLProviderConfigData): Promise<boolean>;
+    get sessionId(): string;
+    protected get AllowRefresh(): boolean;
+    protected GetCurrentUser(): Promise<UserInfo>;
+    /**************************************************************************/
+    /**************************************************************************/
+    RunReport(params: RunReportParams, contextUser?: UserInfo): Promise<RunReportResult>;
+    /**************************************************************************/
+    /**************************************************************************/
+    /**************************************************************************/
+    /**************************************************************************/
+    RunQuery(params: RunQueryParams, contextUser?: UserInfo): Promise<RunQueryResult>;
+    /**************************************************************************/
+    /**************************************************************************/
+    /**************************************************************************/
+    /**************************************************************************/
+    RunView<T = any>(params: RunViewParams, contextUser?: UserInfo): Promise<RunViewResult<T>>;
+    protected getEntityNameAndUserView(params: RunViewParams, contextUser?: UserInfo): Promise<{
+        entityName: string;
+        v: UserViewEntityExtended;
+    }>;
+    protected getViewRunTimeFieldList(e: EntityInfo, v: UserViewEntityExtended, params: RunViewParams, dynamicView: boolean): string[];
+    /**************************************************************************/
+    /**************************************************************************/
+    /**************************************************************************/
+    /**************************************************************************/
+    get ProviderType(): ProviderType;
+    GetRecordChanges(entityName: string, primaryKey: CompositeKey): Promise<RecordChange[]>;
+    /**
+     * Returns a list of dependencies - records that are linked to the specified Entity/KeyValuePairs combination. A dependency is as defined by the relationships in the database. The MemberJunction metadata that is used
+     * for this simply reflects the foreign key relationships that exist in the database. The CodeGen tool is what detects all of the relationships and generates the metadata that is used by MemberJunction. The metadata in question
+     * is within the EntityField table and specifically the RelatedEntity and RelatedEntityField columns. In turn, this method uses that metadata and queries the database to determine the dependencies. To get the list of entity dependencies
+     * you can use the utility method GetEntityDependencies(), which doesn't check for dependencies on a specific record, but rather gets the metadata in one shot that can be used for dependency checking.
+     * @param entityName the name of the entity to check
+     * @param KeyValuePairs the KeyValuePairs of the record to check
+     */
+    GetRecordDependencies(entityName: string, primaryKey: CompositeKey): Promise<RecordDependency[]>;
+    protected ensureKeyValuePairValueIsString(kvps: KeyValuePair[]): {
+        FieldName: string;
+        Value: string;
+    }[];
+    GetRecordDuplicates(params: PotentialDuplicateRequest, contextUser?: UserInfo): Promise<PotentialDuplicateResponse>;
+    MergeRecords(request: RecordMergeRequest): Promise<RecordMergeResult>;
+    Save(entity: BaseEntity, user: UserInfo, options: EntitySaveOptions): Promise<{}>;
+    Load(entity: BaseEntity, primaryKey: CompositeKey, EntityRelationshipsToLoad: string[], user: UserInfo): Promise<{}>;
+    protected getRelatedEntityString(entityInfo: EntityInfo, EntityRelationshipsToLoad: string[]): string;
+    Delete(entity: BaseEntity, options: EntityDeleteOptions, user: UserInfo): Promise<boolean>;
+    /**************************************************************************/
+    /**************************************************************************/
+    /**************************************************************************/
+    /**************************************************************************/
+    GetDatasetByName(datasetName: string, itemFilters?: DatasetItemFilterType[]): Promise<DatasetResultType>;
+    GetDatasetStatusByName(datasetName: string, itemFilters?: DatasetItemFilterType[]): Promise<DatasetStatusResultType>;
+    CreateTransactionGroup(): Promise<TransactionGroupBase>;
+    GetRecordFavoriteStatus(userId: number, entityName: string, primaryKey: CompositeKey): Promise<boolean>;
+    SetRecordFavoriteStatus(userId: number, entityName: string, primaryKey: CompositeKey, isFavorite: boolean, contextUser: UserInfo): Promise<void>;
+    GetEntityRecordName(entityName: string, primaryKey: CompositeKey): Promise<string>;
+    GetEntityRecordNames(info: EntityRecordNameInput[]): Promise<EntityRecordNameResult[]>;
+    static ExecuteGQL(query: string, variables: any, refreshTokenIfNeeded?: boolean): Promise<any>;
+    static RefreshToken(): Promise<void>;
+    protected static CreateNewGraphQLClient(url: string, token: string, sessionId: string): GraphQLClient;
+    private _innerCurrentUserQueryString;
+    private _currentUserQuery;
+    private userInfoString;
+    private userRoleInfoString;
+    private infoString;
+    private _localStorageProvider;
+    get LocalStorageProvider(): ILocalStorageProvider;
+    /**************************************************************************/
+    /**************************************************************************/
+    protected get Metadata(): IMetadataProvider;
+    private _wsClient;
+    private _pushStatusRequests;
+    PushStatusUpdates(sessionId?: string): Observable<string>;
+}