@memberjunction/graphql-dataprovider 2.20.3 → 2.22.0

package/dist/index.d.cts

@@ -1,71 +1,9 @@
 import { GraphQLClient } from 'graphql-request';
 export { gql } from 'graphql-request';
-import { CompositeKey, ProviderConfigDataBase, ProviderBase, IEntityDataProvider, IMetadataProvider, IRunViewProvider, IRunReportProvider, IRunQueryProvider, UserInfo, RunReportParams, RunReportResult, RunQueryParams, RunQueryResult, RunViewParams, RunViewResult, EntityInfo, ProviderType, RecordChange, RecordDependency, KeyValuePair, PotentialDuplicateRequest, PotentialDuplicateResponse, RecordMergeRequest, RecordMergeResult, BaseEntity, EntitySaveOptions, EntityDeleteOptions, DatasetItemFilterType, DatasetResultType, DatasetStatusResultType, TransactionGroupBase, EntityRecordNameInput, EntityRecordNameResult, ILocalStorageProvider } from '@memberjunction/core';
+import { ProviderConfigDataBase, ProviderBase, IEntityDataProvider, IMetadataProvider, IRunViewProvider, IRunReportProvider, IRunQueryProvider, UserInfo, RunReportParams, RunReportResult, RunQueryParams, RunQueryResult, RunViewParams, RunViewResult, EntityInfo, ProviderType, CompositeKey, RecordChange, RecordDependency, KeyValuePair, PotentialDuplicateRequest, PotentialDuplicateResponse, RecordMergeRequest, RecordMergeResult, BaseEntity, EntitySaveOptions, EntityDeleteOptions, DatasetItemFilterType, DatasetResultType, DatasetStatusResultType, TransactionGroupBase, EntityRecordNameInput, EntityRecordNameResult, ILocalStorageProvider } from '@memberjunction/core';
 import { UserViewEntityExtended } from '@memberjunction/core-entities';
 import { Observable } from 'rxjs';
 
-declare class RoleInput {
-    ID: string;
-    Name: string;
-    Description: string;
-}
-declare class UserInput {
-    ID: string;
-    Name: string;
-    Email: string;
-    Type: 'Owner' | 'User';
-    FirstName: string;
-    LastName: string;
-    Title: string;
-    Roles?: RoleInput[];
-}
-declare class RolesAndUsersInput {
-    Users: UserInput[];
-    Roles: RoleInput[];
-}
-declare enum SyncDataActionType {
-    Create = "Create",
-    Update = "Update",
-    CreateOrUpdate = "CreateOrUpdate",
-    Delete = "Delete",
-    DeleteWithFilter = "DeleteWithFilter"
-}
-declare class ActionItemInput {
-    /**
-     * The name of the entity where action is to be taken
-     */
-    EntityName: string;
-    /**
-     * For Update, CreateOrUpdate and Delete operations either a PrimaryKey or an AlternateKey must be provided. For Create and DeleteWithFilter operations, neither is used.
-     */
-    PrimaryKey?: CompositeKey;
-    /**
-     * For Update, CreateOrUpdate and Delete operations either a PrimaryKey or an AlternateKey must be provided. For Create and DeleteWithFilter operations, neither is used.
-     */
-    AlternateKey?: CompositeKey;
-    /**
-     * The type of action requested. The possible values are Create, Update, CreateOrUpdate, Delete, DeleteWithFilter
-     */
-    Type: SyncDataActionType;
-    /**
-     * This field is a JSON representation of the field values of the entity to be created or updated. It is used for all ActionTypes except for
-     */
-    RecordJSON?: string;
-    /**
-     * This field is only provided when the Action Type is DeleteWithFilter. It is a valid SQL expression that can be used in a where clause to get a list of records in a given entity to delete
-     */
-    DeleteFilter?: string;
-}
-declare class SyncDataResult {
-    Success: boolean;
-    Results: ActionItemOutput[];
-}
-declare class ActionItemOutput {
-    input: ActionItemInput;
-    success: boolean;
-    errorMessage: string;
-}
-
 /**************************************************************************************************************
  * The graphQLDataProvider provides a data provider for the entities framework that uses GraphQL to communicate
  * with the server.
@@ -259,16 +197,6 @@ declare class GraphQLDataProvider extends ProviderBase implements IEntityDataPro
     private _wsClient;
     private _pushStatusRequests;
     PushStatusUpdates(sessionId?: string): Observable<string>;
-    /**
-     * Utility method to call the Sync Roles and Users mutation on the MJ API server, this can only be invoked by the system user
-     * @param data
-     */
-    SyncRolesAndUsers(data: RolesAndUsersInput): Promise<boolean>;
-    /**
-     * Utility method to call the Sync Roles and Users mutation on the MJ API server, this can only be invoked by the system user
-     * @param data
-     */
-    SyncData(items: ActionItemInput[]): Promise<SyncDataResult>;
 }
 
 /**
@@ -312,4 +240,219 @@ declare class FieldMapper {
     ReverseMapFields(obj: Record<string, unknown>): Record<string, unknown>;
 }
 
-export { ActionItemInput, ActionItemOutput, FieldMapper, GraphQLDataProvider, GraphQLProviderConfigData, RoleInput, RolesAndUsersInput, SyncDataActionType, SyncDataResult, UserInput, setupGraphQLClient };
+declare class SyncRolesAndUsersResult {
+    Success: boolean;
+}
+declare class RoleInput {
+    ID: string;
+    Name: string;
+    Description: string;
+}
+declare class UserInput {
+    ID: string;
+    Name: string;
+    Email: string;
+    Type: 'Owner' | 'User';
+    FirstName: string;
+    LastName: string;
+    Title: string;
+    Roles?: RoleInput[];
+}
+declare class RolesAndUsersInput {
+    Users: UserInput[];
+    Roles: RoleInput[];
+}
+/**
+ * This type defines the possible list of actions that can be taken in syncing data: Create, Update, CreateOrUpdate, Delete, or DeleteWithFilter
+ * DeleteWithFilter is where you specify a valid SQL expression that can be used in a where clause to get a list of records in a given entity to delete
+ * this can be used to ensure cleaning out data from a subset of a given table.
+ */
+declare enum SyncDataAction {
+    Create = "Create",
+    Update = "Update",
+    CreateOrUpdate = "CreateOrUpdate",
+    Delete = "Delete",
+    DeleteWithFilter = "DeleteWithFilter"
+}
+declare class ActionItemInput {
+    /**
+     * The name of the entity where action is to be taken
+     */
+    EntityName: string;
+    /**
+     * For Update, CreateOrUpdate and Delete operations either a PrimaryKey or an AlternateKey must be provided. For Create and DeleteWithFilter operations, neither is used.
+     */
+    PrimaryKey?: CompositeKey;
+    /**
+     * For Update, CreateOrUpdate and Delete operations either a PrimaryKey or an AlternateKey must be provided. For Create and DeleteWithFilter operations, neither is used.
+     */
+    AlternateKey?: CompositeKey;
+    /**
+     * The type of action requested. The possible values are Create, Update, CreateOrUpdate, Delete, DeleteWithFilter
+     */
+    Type: SyncDataAction;
+    /**
+     * This field is a JSON representation of the field values of the entity to be created or updated. It is used for all ActionTypes except for
+     */
+    RecordJSON?: string;
+    /**
+     * This field is only provided when the Action Type is DeleteWithFilter. It is a valid SQL expression that can be used in a where clause to get a list of records in a given entity to delete
+     */
+    DeleteFilter?: string;
+}
+declare class SyncDataResult {
+    Success: boolean;
+    Results: ActionItemOutput[];
+}
+declare class ActionItemOutput {
+    Success: boolean;
+    ErrorMessage: string;
+    EntityName: string;
+    PrimaryKey?: CompositeKey;
+    AlternateKey?: CompositeKey;
+    Type: SyncDataAction;
+    /**
+     * This field is a JSON representation of the field values of the entity to be created or updated. It is used for all ActionTypes except for
+     */
+    RecordJSON?: string;
+    /**
+     * This field is only provided when the Action Type is DeleteWithFilter. It is a valid SQL expression that can be used in a where clause to get a list of records in a given entity to delete
+     */
+    DeleteFilter?: string;
+}
+
+/**
+ * Specialized client that is designed to be used exclusively on the server side
+ * by the System User using the MJ API KEY. This is designed to allow server side
+ * code such as within the context of an MJAPI server to talk to another MAJPI server
+ * but as the client.
+ *
+ * It is possible for a server to use the regular @GraphQLDataProvider client to talk
+ * to another MJAPI server, but that would require the server to have a user account
+ * and the server would have to be able to log in as that user via a JWT token. This
+ * is not always possible or convenient in the flow.
+ *
+ * Also the standard client configuration process has a certain amount over overhead
+ * in always loading up certain metadata that is not necessary for many system user
+ * operations.
+ *
+ * Finaly, this client can be used in parallel with the regular client to allow a server
+ * to mix and match the two as needed.
+ */
+declare class GraphQLSystemUserClient {
+    private _client;
+    /**
+     * Returns the underlying GraphQL client which is an instance of the GraphQLClient object
+     * from the graphql-request package. This is useful if you want to perform any operation
+     * that is not directly supported by this class via specialized methods.
+     */
+    get Client(): GraphQLClient;
+    /**
+     * @param url MJAPI server URL
+     * @param token Optional, JWT token that is used for a normal user authentication flow. This is required if mjAPIKey is not provided.
+     * @param sessionId Optional, UUID that is used to track a session. This can be any string.
+     * @param mjAPIKey Shared Secret key that is provided for system user authentication. This is required if token is not provided.
+     * @returns
+     */
+    constructor(url: string, token: string, sessionId: string, mjAPIKey: string);
+    /**
+     * Calls the GetData() query on the server to execute any number of provided SQL queries in parallel and returns the results.
+     * The queries MUST BE read only and not perform any DML operations. The remote server will execute the queries using a special
+     * lower-privilege user that is not allowed to perform any form of write operations.
+     * @param queries an array of SQL queries to execute on the remote server
+     * @param accessToken the short-lived access token that is required to perform this operation. This is different from the MJAPI key and is used for a second factor and is a short-lived token. You will receive this token
+     * when an MJAPI calls your server to request something along with the URL to call back.
+     * @returns
+     */
+    GetData(queries: string[], accessToken: string): Promise<GetDataOutput>;
+    /**
+     * This method will return a list of all entities that are available on the remote server. This is a lightweight call that only returns the basic metadata for each entity and does not include all of the attributes at
+     * either the entity or the field level. This is useful for getting a list of entities that are available on the remote server and knowing their IDs and Entity Field IDs on the remote server. For core MemberJunction
+     * entities and entity fields, the ID values are globally unique and set by the MemberJunction distribution, however, for other entities that are generated on each target system they can vary so it is best to use
+     * lookups name or a combination of SchemaName and BaseTable to uniquely identify an entity.
+     * @param client
+     * @returns
+     */
+    GetAllRemoteEntities(): Promise<SimpleRemoteEntityOutput>;
+    /**
+     * This method is used to invoke the data synchronization mutation on the remote server. This method is used to create, update, or delete records in the remote server. The method takes an array of ActionItemInput objects
+     * Each of the ActionItemInput objects represents a single action to take on a single entity. The action can be Create, Update, CreateOrUpdate, Delete, or DeleteWithFilter. The RecordJSON field is used for Create, CreateOrUpdate and Update whereas
+     * the DeleteFilter field is used for DeleteWithFilter. The PrimaryKey and AlternateKey fields are used to identify the record to be acted upon.
+     *
+     * Use of the AlternateKey is important for situations where you might have divergent primary keys across systems. For example for user entities that are individually generated on each system by CodeGen, the primary key will
+     * be different per system, so you would use the combination of the SchemaName and BaseTable to identify the entity and then use the AlternateKey to provide the combination of these fields to uniquely identify the record for updates.
+     * @param items
+     * @returns
+     */
+    SyncData(items: ActionItemInput[]): Promise<SyncDataResult>;
+    /**
+     * This method will sync the roles and users on the remote server. This method is used to create, update, or delete roles and users on the remote server.
+     * The method takes a RolesAndUsersInput object that contains an array of RoleInput objects. Note that this will not result in the removal of roles on the
+     * remote server that are deemed to be built-in MemberJunction roles such as Developer, Integration and UI.
+     * @param data
+     * @returns
+     */
+    SyncRolesAndUsers(data: RolesAndUsersInput): Promise<SyncRolesAndUsersResult>;
+}
+/**
+ * Output type for GetData calls
+ */
+declare class GetDataOutput {
+    /**
+     * Indicates if the operation was successful overall. If any individual query failed, this will be false. However, any successful queries will still be returned in the Results array.
+     */
+    Success: boolean;
+    /**
+     * The original input of Queries that were run
+     */
+    Queries: string[];
+    /**
+     * An ordered array of error messages for each query that was run. This array will always have the same # of entries as Queries. If a query was successful, the corresponding entry will be null.
+     */
+    ErrorMessages: (string | null)[];
+    /**
+     * An ordered array of results for each query that was run. This array will always have the same # of entries as Queries. If a query failed, the corresponding entry will be null.
+     */
+    Results: (string | null)[];
+}
+/**
+ * Return type for calls to the GetAllRemoteEntities query
+ */
+declare class SimpleRemoteEntityOutput {
+    Success: boolean;
+    ErrorMessage?: string;
+    /**
+     * An array of simple entity types that are returned from the remote server
+     */
+    Results: SimpleRemoteEntity[];
+}
+/**
+ * Represents a simple entity type that is used for lightweight retrieval of partial remote entity metadata
+ */
+declare class SimpleRemoteEntity {
+    /**
+     * ID of the entity on the remote server
+     */
+    ID: string;
+    Name: string;
+    Description?: string;
+    SchemaName: string;
+    BaseView: string;
+    BaseTable: string;
+    CodeName?: string;
+    ClassName?: string;
+    Fields: SimpleRemoteEntityField[];
+}
+declare class SimpleRemoteEntityField {
+    /**
+     * ID of the entity field on the remote server
+     */
+    ID: string;
+    Name: string;
+    Description?: string;
+    Type: string;
+    AllowsNull: boolean;
+    MaxLength: number;
+}
+
+export { ActionItemInput, ActionItemOutput, FieldMapper, GetDataOutput, GraphQLDataProvider, GraphQLProviderConfigData, GraphQLSystemUserClient, RoleInput, RolesAndUsersInput, SimpleRemoteEntity, SimpleRemoteEntityField, SimpleRemoteEntityOutput, SyncDataAction, SyncDataResult, SyncRolesAndUsersResult, UserInput, setupGraphQLClient };

package/dist/index.d.mts

@@ -1,71 +1,9 @@
 import { GraphQLClient } from 'graphql-request';
 export { gql } from 'graphql-request';
-import { CompositeKey, ProviderConfigDataBase, ProviderBase, IEntityDataProvider, IMetadataProvider, IRunViewProvider, IRunReportProvider, IRunQueryProvider, UserInfo, RunReportParams, RunReportResult, RunQueryParams, RunQueryResult, RunViewParams, RunViewResult, EntityInfo, ProviderType, RecordChange, RecordDependency, KeyValuePair, PotentialDuplicateRequest, PotentialDuplicateResponse, RecordMergeRequest, RecordMergeResult, BaseEntity, EntitySaveOptions, EntityDeleteOptions, DatasetItemFilterType, DatasetResultType, DatasetStatusResultType, TransactionGroupBase, EntityRecordNameInput, EntityRecordNameResult, ILocalStorageProvider } from '@memberjunction/core';
+import { ProviderConfigDataBase, ProviderBase, IEntityDataProvider, IMetadataProvider, IRunViewProvider, IRunReportProvider, IRunQueryProvider, UserInfo, RunReportParams, RunReportResult, RunQueryParams, RunQueryResult, RunViewParams, RunViewResult, EntityInfo, ProviderType, CompositeKey, RecordChange, RecordDependency, KeyValuePair, PotentialDuplicateRequest, PotentialDuplicateResponse, RecordMergeRequest, RecordMergeResult, BaseEntity, EntitySaveOptions, EntityDeleteOptions, DatasetItemFilterType, DatasetResultType, DatasetStatusResultType, TransactionGroupBase, EntityRecordNameInput, EntityRecordNameResult, ILocalStorageProvider } from '@memberjunction/core';
 import { UserViewEntityExtended } from '@memberjunction/core-entities';
 import { Observable } from 'rxjs';
 
-declare class RoleInput {
-    ID: string;
-    Name: string;
-    Description: string;
-}
-declare class UserInput {
-    ID: string;
-    Name: string;
-    Email: string;
-    Type: 'Owner' | 'User';
-    FirstName: string;
-    LastName: string;
-    Title: string;
-    Roles?: RoleInput[];
-}
-declare class RolesAndUsersInput {
-    Users: UserInput[];
-    Roles: RoleInput[];
-}
-declare enum SyncDataActionType {
-    Create = "Create",
-    Update = "Update",
-    CreateOrUpdate = "CreateOrUpdate",
-    Delete = "Delete",
-    DeleteWithFilter = "DeleteWithFilter"
-}
-declare class ActionItemInput {
-    /**
-     * The name of the entity where action is to be taken
-     */
-    EntityName: string;
-    /**
-     * For Update, CreateOrUpdate and Delete operations either a PrimaryKey or an AlternateKey must be provided. For Create and DeleteWithFilter operations, neither is used.
-     */
-    PrimaryKey?: CompositeKey;
-    /**
-     * For Update, CreateOrUpdate and Delete operations either a PrimaryKey or an AlternateKey must be provided. For Create and DeleteWithFilter operations, neither is used.
-     */
-    AlternateKey?: CompositeKey;
-    /**
-     * The type of action requested. The possible values are Create, Update, CreateOrUpdate, Delete, DeleteWithFilter
-     */
-    Type: SyncDataActionType;
-    /**
-     * This field is a JSON representation of the field values of the entity to be created or updated. It is used for all ActionTypes except for
-     */
-    RecordJSON?: string;
-    /**
-     * This field is only provided when the Action Type is DeleteWithFilter. It is a valid SQL expression that can be used in a where clause to get a list of records in a given entity to delete
-     */
-    DeleteFilter?: string;
-}
-declare class SyncDataResult {
-    Success: boolean;
-    Results: ActionItemOutput[];
-}
-declare class ActionItemOutput {
-    input: ActionItemInput;
-    success: boolean;
-    errorMessage: string;
-}
-
 /**************************************************************************************************************
  * The graphQLDataProvider provides a data provider for the entities framework that uses GraphQL to communicate
  * with the server.
@@ -259,16 +197,6 @@ declare class GraphQLDataProvider extends ProviderBase implements IEntityDataPro
     private _wsClient;
     private _pushStatusRequests;
     PushStatusUpdates(sessionId?: string): Observable<string>;
-    /**
-     * Utility method to call the Sync Roles and Users mutation on the MJ API server, this can only be invoked by the system user
-     * @param data
-     */
-    SyncRolesAndUsers(data: RolesAndUsersInput): Promise<boolean>;
-    /**
-     * Utility method to call the Sync Roles and Users mutation on the MJ API server, this can only be invoked by the system user
-     * @param data
-     */
-    SyncData(items: ActionItemInput[]): Promise<SyncDataResult>;
 }
 
 /**
@@ -312,4 +240,219 @@ declare class FieldMapper {
     ReverseMapFields(obj: Record<string, unknown>): Record<string, unknown>;
 }
 
-export { ActionItemInput, ActionItemOutput, FieldMapper, GraphQLDataProvider, GraphQLProviderConfigData, RoleInput, RolesAndUsersInput, SyncDataActionType, SyncDataResult, UserInput, setupGraphQLClient };
+declare class SyncRolesAndUsersResult {
+    Success: boolean;
+}
+declare class RoleInput {
+    ID: string;
+    Name: string;
+    Description: string;
+}
+declare class UserInput {
+    ID: string;
+    Name: string;
+    Email: string;
+    Type: 'Owner' | 'User';
+    FirstName: string;
+    LastName: string;
+    Title: string;
+    Roles?: RoleInput[];
+}
+declare class RolesAndUsersInput {
+    Users: UserInput[];
+    Roles: RoleInput[];
+}
+/**
+ * This type defines the possible list of actions that can be taken in syncing data: Create, Update, CreateOrUpdate, Delete, or DeleteWithFilter
+ * DeleteWithFilter is where you specify a valid SQL expression that can be used in a where clause to get a list of records in a given entity to delete
+ * this can be used to ensure cleaning out data from a subset of a given table.
+ */
+declare enum SyncDataAction {
+    Create = "Create",
+    Update = "Update",
+    CreateOrUpdate = "CreateOrUpdate",
+    Delete = "Delete",
+    DeleteWithFilter = "DeleteWithFilter"
+}
+declare class ActionItemInput {
+    /**
+     * The name of the entity where action is to be taken
+     */
+    EntityName: string;
+    /**
+     * For Update, CreateOrUpdate and Delete operations either a PrimaryKey or an AlternateKey must be provided. For Create and DeleteWithFilter operations, neither is used.
+     */
+    PrimaryKey?: CompositeKey;
+    /**
+     * For Update, CreateOrUpdate and Delete operations either a PrimaryKey or an AlternateKey must be provided. For Create and DeleteWithFilter operations, neither is used.
+     */
+    AlternateKey?: CompositeKey;
+    /**
+     * The type of action requested. The possible values are Create, Update, CreateOrUpdate, Delete, DeleteWithFilter
+     */
+    Type: SyncDataAction;
+    /**
+     * This field is a JSON representation of the field values of the entity to be created or updated. It is used for all ActionTypes except for
+     */
+    RecordJSON?: string;
+    /**
+     * This field is only provided when the Action Type is DeleteWithFilter. It is a valid SQL expression that can be used in a where clause to get a list of records in a given entity to delete
+     */
+    DeleteFilter?: string;
+}
+declare class SyncDataResult {
+    Success: boolean;
+    Results: ActionItemOutput[];
+}
+declare class ActionItemOutput {
+    Success: boolean;
+    ErrorMessage: string;
+    EntityName: string;
+    PrimaryKey?: CompositeKey;
+    AlternateKey?: CompositeKey;
+    Type: SyncDataAction;
+    /**
+     * This field is a JSON representation of the field values of the entity to be created or updated. It is used for all ActionTypes except for
+     */
+    RecordJSON?: string;
+    /**
+     * This field is only provided when the Action Type is DeleteWithFilter. It is a valid SQL expression that can be used in a where clause to get a list of records in a given entity to delete
+     */
+    DeleteFilter?: string;
+}
+
+/**
+ * Specialized client that is designed to be used exclusively on the server side
+ * by the System User using the MJ API KEY. This is designed to allow server side
+ * code such as within the context of an MJAPI server to talk to another MAJPI server
+ * but as the client.
+ *
+ * It is possible for a server to use the regular @GraphQLDataProvider client to talk
+ * to another MJAPI server, but that would require the server to have a user account
+ * and the server would have to be able to log in as that user via a JWT token. This
+ * is not always possible or convenient in the flow.
+ *
+ * Also the standard client configuration process has a certain amount over overhead
+ * in always loading up certain metadata that is not necessary for many system user
+ * operations.
+ *
+ * Finaly, this client can be used in parallel with the regular client to allow a server
+ * to mix and match the two as needed.
+ */
+declare class GraphQLSystemUserClient {
+    private _client;
+    /**
+     * Returns the underlying GraphQL client which is an instance of the GraphQLClient object
+     * from the graphql-request package. This is useful if you want to perform any operation
+     * that is not directly supported by this class via specialized methods.
+     */
+    get Client(): GraphQLClient;
+    /**
+     * @param url MJAPI server URL
+     * @param token Optional, JWT token that is used for a normal user authentication flow. This is required if mjAPIKey is not provided.
+     * @param sessionId Optional, UUID that is used to track a session. This can be any string.
+     * @param mjAPIKey Shared Secret key that is provided for system user authentication. This is required if token is not provided.
+     * @returns
+     */
+    constructor(url: string, token: string, sessionId: string, mjAPIKey: string);
+    /**
+     * Calls the GetData() query on the server to execute any number of provided SQL queries in parallel and returns the results.
+     * The queries MUST BE read only and not perform any DML operations. The remote server will execute the queries using a special
+     * lower-privilege user that is not allowed to perform any form of write operations.
+     * @param queries an array of SQL queries to execute on the remote server
+     * @param accessToken the short-lived access token that is required to perform this operation. This is different from the MJAPI key and is used for a second factor and is a short-lived token. You will receive this token
+     * when an MJAPI calls your server to request something along with the URL to call back.
+     * @returns
+     */
+    GetData(queries: string[], accessToken: string): Promise<GetDataOutput>;
+    /**
+     * This method will return a list of all entities that are available on the remote server. This is a lightweight call that only returns the basic metadata for each entity and does not include all of the attributes at
+     * either the entity or the field level. This is useful for getting a list of entities that are available on the remote server and knowing their IDs and Entity Field IDs on the remote server. For core MemberJunction
+     * entities and entity fields, the ID values are globally unique and set by the MemberJunction distribution, however, for other entities that are generated on each target system they can vary so it is best to use
+     * lookups name or a combination of SchemaName and BaseTable to uniquely identify an entity.
+     * @param client
+     * @returns
+     */
+    GetAllRemoteEntities(): Promise<SimpleRemoteEntityOutput>;
+    /**
+     * This method is used to invoke the data synchronization mutation on the remote server. This method is used to create, update, or delete records in the remote server. The method takes an array of ActionItemInput objects
+     * Each of the ActionItemInput objects represents a single action to take on a single entity. The action can be Create, Update, CreateOrUpdate, Delete, or DeleteWithFilter. The RecordJSON field is used for Create, CreateOrUpdate and Update whereas
+     * the DeleteFilter field is used for DeleteWithFilter. The PrimaryKey and AlternateKey fields are used to identify the record to be acted upon.
+     *
+     * Use of the AlternateKey is important for situations where you might have divergent primary keys across systems. For example for user entities that are individually generated on each system by CodeGen, the primary key will
+     * be different per system, so you would use the combination of the SchemaName and BaseTable to identify the entity and then use the AlternateKey to provide the combination of these fields to uniquely identify the record for updates.
+     * @param items
+     * @returns
+     */
+    SyncData(items: ActionItemInput[]): Promise<SyncDataResult>;
+    /**
+     * This method will sync the roles and users on the remote server. This method is used to create, update, or delete roles and users on the remote server.
+     * The method takes a RolesAndUsersInput object that contains an array of RoleInput objects. Note that this will not result in the removal of roles on the
+     * remote server that are deemed to be built-in MemberJunction roles such as Developer, Integration and UI.
+     * @param data
+     * @returns
+     */
+    SyncRolesAndUsers(data: RolesAndUsersInput): Promise<SyncRolesAndUsersResult>;
+}
+/**
+ * Output type for GetData calls
+ */
+declare class GetDataOutput {
+    /**
+     * Indicates if the operation was successful overall. If any individual query failed, this will be false. However, any successful queries will still be returned in the Results array.
+     */
+    Success: boolean;
+    /**
+     * The original input of Queries that were run
+     */
+    Queries: string[];
+    /**
+     * An ordered array of error messages for each query that was run. This array will always have the same # of entries as Queries. If a query was successful, the corresponding entry will be null.
+     */
+    ErrorMessages: (string | null)[];
+    /**
+     * An ordered array of results for each query that was run. This array will always have the same # of entries as Queries. If a query failed, the corresponding entry will be null.
+     */
+    Results: (string | null)[];
+}
+/**
+ * Return type for calls to the GetAllRemoteEntities query
+ */
+declare class SimpleRemoteEntityOutput {
+    Success: boolean;
+    ErrorMessage?: string;
+    /**
+     * An array of simple entity types that are returned from the remote server
+     */
+    Results: SimpleRemoteEntity[];
+}
+/**
+ * Represents a simple entity type that is used for lightweight retrieval of partial remote entity metadata
+ */
+declare class SimpleRemoteEntity {
+    /**
+     * ID of the entity on the remote server
+     */
+    ID: string;
+    Name: string;
+    Description?: string;
+    SchemaName: string;
+    BaseView: string;
+    BaseTable: string;
+    CodeName?: string;
+    ClassName?: string;
+    Fields: SimpleRemoteEntityField[];
+}
+declare class SimpleRemoteEntityField {
+    /**
+     * ID of the entity field on the remote server
+     */
+    ID: string;
+    Name: string;
+    Description?: string;
+    Type: string;
+    AllowsNull: boolean;
+    MaxLength: number;
+}
+
+export { ActionItemInput, ActionItemOutput, FieldMapper, GetDataOutput, GraphQLDataProvider, GraphQLProviderConfigData, GraphQLSystemUserClient, RoleInput, RolesAndUsersInput, SimpleRemoteEntity, SimpleRemoteEntityField, SimpleRemoteEntityOutput, SyncDataAction, SyncDataResult, SyncRolesAndUsersResult, UserInput, setupGraphQLClient };