Class LambdaClient

Hierarchy

LambdaClient

Implements

GraphQLClientInterface

Index

Constructors

constructor

new LambdaClient(config: RuntimeConfig): LambdaClient
Parameters
- config: RuntimeConfig
Returns LambdaClient
- Defined in src/graphqlClient/LambdaClient.ts:20

Properties

`Protected` config

config: RuntimeConfig

Methods

`Private` executeGraphQL

executeGraphQL(graphqlLambdaFunctionName: string, payload: any): Promise<any>
Parameters
- graphqlLambdaFunctionName: string
- payload: any
Returns Promise<any>
- Defined in src/graphqlClient/LambdaClient.ts:88

`Private` getEventPayload

getEventPayload(userContext: ContextUser, query: string, variables: Record<string, unknown>): {
    body: string;
    headers: {
        content-type: string;
    };
    httpMethod: string;
    path: string;
    requestContext: {
        authorizer: {
            claims: {
                cognito:groups: string[];
                iss: string;
                sub: string;
            };
        };
    };
}
This function is used to create the request payload that we will call the GraphQL backend with.
Parameters
- userContext: ContextUser
  
  The user context that the call will be made on behalf of
- query: string
  
  The GraphQL string query
- variables: Record<string, unknown>
Returns {
    body: string;
    headers: {
        content-type: string;
    };
    httpMethod: string;
    path: string;
    requestContext: {
        authorizer: {
            claims: {
                cognito:groups: string[];
                iss: string;
                sub: string;
            };
        };
    };
}
- body: string
- headers: {
  content-type: string;
  }
  - content-type: string
- httpMethod: string
- path: string
- requestContext: {
      authorizer: {
          claims: {
              cognito:groups: string[];
              iss: string;
              sub: string;
          };
      };
  }
  - authorizer: {
        claims: {
            cognito:groups: string[];
            iss: string;
            sub: string;
        };
    }
    - claims: {
          cognito:groups: string[];
          iss: string;
          sub: string;
      }
      - cognito:groups: string[]
      - iss: string
      - sub: string
- Defined in src/graphqlClient/LambdaClient.ts:111

query

query(query: string, variables: Variables, actor: Actor): Promise<any>
This is used to run a GraphQL query directly against a Kosmos GraphQL Lambda function.

The following config properties are expected:

cognito_iss: The Cognito Issuer URL.

Examples: cognito_iss https://cognito-idp.eu-west-2.amazonaws.com/eu-west-2_hkzLlc3qU

The GraphQL Lambda is executed on behalf of the provided actor.
Parameters
- query: string
  
  The GraphQL query or mutation to run.
- variables: Variables
  
  Variables for the grpahql query.
- actor: Actor
  
  An object representing the user performing the action.
Returns Promise<any>
Implementation of GraphQLClientInterface.query
- Defined in src/graphqlClient/LambdaClient.ts:40

`Private` validateQuery

validateQuery(actor: Actor): ContextUser
This method is used to verify that all the environment variables required to create the user context have been configured.

Returns
a valid Context user
Parameters
- actor: Actor
  
  An object representing the user making the request
Returns ContextUser
- Defined in src/graphqlClient/LambdaClient.ts:72

Class LambdaClient

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: RuntimeConfig

Returns LambdaClient

Properties

Protected config

Methods

Private executeGraphQL

Parameters

graphqlLambdaFunctionName: string

payload: any

Returns Promise<any>

Private getEventPayload

Parameters

userContext: ContextUser

query: string

variables: Record<string, unknown>

Returns { body: string; headers: { content-type: string; }; httpMethod: string; path: string; requestContext: { authorizer: { claims: { cognito:groups: string[]; iss: string; sub: string; }; }; }; }

body: string

headers: { content-type: string; }

content-type: string

httpMethod: string

path: string

requestContext: { authorizer: { claims: { cognito:groups: string[]; iss: string; sub: string; }; }; }

authorizer: { claims: { cognito:groups: string[]; iss: string; sub: string; }; }

claims: { cognito:groups: string[]; iss: string; sub: string; }

cognito:groups: string[]

iss: string

sub: string

query

Parameters

query: string

variables: Variables

actor: Actor

Returns Promise<any>

Private validateQuery

Returns

Parameters

actor: Actor

Returns ContextUser

Settings

Member Visibility

Theme

`Protected` config

`Private` executeGraphQL

`Private` getEventPayload

Returns {
body: string;
headers: {
content-type: string;
};
httpMethod: string;
path: string;
requestContext: {
authorizer: {
claims: {
cognito:groups: string[];
iss: string;
sub: string;
};
};
};
}

headers: {
content-type: string;
}

requestContext: {
authorizer: {
claims: {
cognito:groups: string[];
iss: string;
sub: string;
};
};
}

authorizer: {
claims: {
cognito:groups: string[];
iss: string;
sub: string;
};
}

claims: {
cognito:groups: string[];
iss: string;
sub: string;
}

`Private` validateQuery