Serverless Helper Plugin JANIS
A plugin for JANIS Commerce to use with the Serverless Helper Framework.
Helpers
base
Used to implement a base service with minimal setup
Option | Type | Description | Attributes | Default value |
---|
serviceCode | string | The service name in lowercase dash separated | Required | |
servicePort | number | The service port | Required | |
apiSecrets | Object | A mapping of stages to Service API Secret | | undefined |
templates
Used to implement Lambda APIs requests and response templates as custom props
No options
authorizers
Used to implement APIs authorizers as custom props
Option | Type | Description | Attributes | Default value |
---|
accountId | string | Indicates the AWS account ID where the authorizers are deployed | Required | |
cors
Used to implement APIs CORS configuration as custom props
If options is undefined
or set to true
it will use the default CORS config for every property.
You can also customize or override every property:
Option | Type | Description | Default value |
---|
replace | boolean | Indicates whether it should replace the CORS properties or merge then with the default | false |
origins | array<string> | An array of allowed origins | See below |
headers | array<string> | An array of allowed headers | See below |
allowCredentials | boolean | Indicates whether the credentials header should be set | true |
maxAge | number | The time in seconds thar CORS headers should be cached | 600 |
CORS Default origins:
[
'https://${self:custom.janisDomains.${self:custom.stage}}',
'https://app.${self:custom.janisDomains.${self:custom.stage}}',
'http://localhost:3001',
'http://janis.localhost:3001',
'http://app.janis.localhost:3001'
]
[
'content-type',
'janis-api-key',
'janis-api-secret',
'janis-client',
'x-api-key',
'x-janis-page',
'x-janis-page-size'
]
api
Used to implement a custom API
Option | Type | Description | Attributes | Default value |
---|
path | string | The API path | Required | |
method | string | The API HTTP Method | | 'get' |
methodName | string | The JANIS API Method | Enum<list, get, post, put, patch, delete> | Defaults to same value of method option |
handler | string | The lambda handler path and function | | 'src/lambda/RestApi/index.handler' |
caching | boolean | Set to true to enable cache | | false |
cors | boolean | Set to true to enable cors | | false |
queryParameters | object | A key value to map query string parameters to a boolean indicating if it's required or not | | |
requestHeaders | object | A key value to map headers to a boolean indicating if it's required or not | | |
authorizer | string | The name of the authorizer | | |
apiList, apiGet, apiPost and apiPut
Used to implement JANIS CRUD APIs.
Option | Type | Description | Attributes | Default value |
---|
entityName | string | The entity name | Required | |
handler | string | The lambda handler path and function | | 'src/lambda/RestApi/index.handler' |
path | string | The API path | | /[entity-name] (for apiList and apiPost) or /[entity-name]/{id} (for apiGet and apiPut) |
caching | boolean | Set to true to enable cache | | false |
cors | boolean | Set to true to enable cors | | false |
queryParameters | object | A key value to map query string parameters to a boolean indicating if it's required or not | | |
requestHeaders | object | A key value to map headers to a boolean indicating if it's required or not | | |
authorizer | string | The name of the authorizer | | |
eventListener
Used to implement JANIS Events listeners
Option | Type | Description | Attributes | Default value |
---|
serviceName | string | The service name | Required | |
entityName | string | The entity name | Required | |
eventName | string | The event name | Required | |
mustHaveClient | boolean | Indicates if authorizer must validate that client or not | | false |
listenersDirName | string | Indicates the path where the event listener files are placed | | 'event-listeners' |
authorizer | string | The name of the authorizer | | If not set, it defaults to ServiceAuthorizer or ServiceNoClientAuthorizer based on the value of mustHaveClient |
Examples
Basic Service with one CRUD operation set and an event listener
'use strict';
const { helper } = require('sls-helper');
module.exports = helper({
hooks: [
['janis.base', {
serviceCode: 'my-service',
servicePort: 5000,
apiSecrets: {
beta: 'foo',
qa: 'bar',
prod: 'baz'
}
}],
'janis.templates',
['janis.authorizers', {
accountId: '012345678910'
}],
'janis.cors',
['janis.api', {
path: '/hello-world',
authorizer: 'NoClientAuthorizer',
cors: true
}],
['janis.apiList', {
entityName: 'product',
authorizer: 'FullAuthorizer',
cors: true
}],
['janis.apiGet', {
entityName: 'product',
authorizer: 'FullAuthorizer',
cors: true
}]
['janis.apiPost', {
entityName: 'product',
authorizer: 'FullAuthorizer',
cors: true
}],
['janis.apiPut', {
entityName: 'product',
authorizer: 'FullAuthorizer',
cors: true
}],
['janis.eventListener', {
serviceName: 'catalog',
entityName: 'product',
eventName: 'created',
mustHaveClient: true
}]
]
}, {});