195 lines
11 KiB
JavaScript
195 lines
11 KiB
JavaScript
module.exports = function() {
|
|
var config = {
|
|
//
|
|
// Test paths. Basically anything called *.spec.js in any of the paths
|
|
// we created (i.e. not node_modules) is a test. We also watch all
|
|
// JS files and re-run the tests if they change.
|
|
//
|
|
test: {
|
|
watchpaths: [
|
|
'**/*.js',
|
|
'!node_modules/**'
|
|
],
|
|
testpaths: [
|
|
'**/*.spec.js', // Everything called *.spec.js
|
|
'!node_modules/**' // But not anything in node_modules
|
|
]
|
|
},
|
|
|
|
//
|
|
// Generated API docs
|
|
//
|
|
api: {
|
|
src: './swagger_api/api_swagger_def.json',
|
|
dest: './docs/swagger_api/',
|
|
indexPath: 'overview.adoc',
|
|
options: {
|
|
dest: './docs/swagger_api/',
|
|
|
|
pages: {
|
|
overview: './tools/docgen/templates/adoc-overview.handlebars',
|
|
paths: './tools/docgen/templates/adoc-paths.handlebars',
|
|
definitions: './tools/docgen/templates/adoc-definitions.handlebars',
|
|
responses: './tools/docgen/templates/adoc-response-definitions.handlebars',
|
|
},
|
|
templates: {
|
|
parameters: './tools/docgen/templates/adoc-parameters.handlebars',
|
|
responses: './tools/docgen/templates/adoc-responses.handlebars',
|
|
schemaOrType: './tools/docgen/templates/adoc-schema-or-type.handlebars',
|
|
range: './tools/docgen/templates/adoc-range.handlebars',
|
|
propertiesRow: './tools/docgen/templates/adoc-properties-row.handlebars',
|
|
}
|
|
},
|
|
watch: ['./tools/docgen/templates/*', './swagger_api/api_swagger_def.json']
|
|
},
|
|
|
|
intApi: {
|
|
src: './integration_api/integration_swagger_def.json',
|
|
dest: './docs/integration_api/',
|
|
indexPath: 'overview.adoc',
|
|
options: {
|
|
dest: './docs/integration_api/',
|
|
|
|
pages: {
|
|
overview: './tools/docgen/templates/adoc-overview.handlebars',
|
|
paths: './tools/docgen/templates/adoc-paths.handlebars',
|
|
definitions: './tools/docgen/templates/adoc-definitions.handlebars',
|
|
responses: './tools/docgen/templates/adoc-response-definitions.handlebars',
|
|
},
|
|
templates: {
|
|
parameters: './tools/docgen/templates/adoc-parameters.handlebars',
|
|
responses: './tools/docgen/templates/adoc-responses.handlebars',
|
|
schemaOrType: './tools/docgen/templates/adoc-schema-or-type.handlebars',
|
|
range: './tools/docgen/templates/adoc-range.handlebars',
|
|
propertiesRow: './tools/docgen/templates/adoc-properties-row.handlebars',
|
|
}
|
|
},
|
|
watch: ['./tools/docgen/templates/*', './integration_api/integration_swagger_def.json']
|
|
},
|
|
|
|
//
|
|
// Docs from the wiki
|
|
//
|
|
wikidocs: {
|
|
dest: './docs/wiki/',
|
|
fileDest: './docs/wiki/files/',
|
|
fileDestRelative: './files',
|
|
schemaDest: './docs/generatedSchemas/',
|
|
indexPath: './docs/wiki/index.adoc',
|
|
sources: [
|
|
// List of wiki slugs to download and add to the final document.
|
|
// They will be added to the page in the order they appear below.
|
|
// NOTE: the Web Dashboard API (swagger api) will always be last.
|
|
// Format of entries is:
|
|
// {slug: '<wiki page slug>', level: <1-based nesting depth in final file>},
|
|
//
|
|
{slug: 'tricore_architecture/server_interface/introduction/', level: 0},
|
|
|
|
{slug: 'tricore_architecture/server_interface/', level: 1},
|
|
|
|
{slug: 'tricore_architecture/server_interface/registration_commands/', level: 2},
|
|
{slug: 'tricore_architecture/server_interface/registration_commands/adddevice/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/registration_commands/deletedevice/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/registration_commands/getclientdetails/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/registration_commands/listdevices/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/registration_commands/register1/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/registration_commands/register2/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/registration_commands/register3/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/registration_commands/register4/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/registration_commands/register6/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/registration_commands/register8/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/registration_commands/resumedevice/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/registration_commands/setclientdetails/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/registration_commands/setdevicename/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/registration_commands/suspenddevice/', level: 3},
|
|
|
|
{slug: 'tricore_architecture/server_interface/login_auth/', level: 2},
|
|
{slug: 'tricore_architecture/server_interface/login_auth/accepteula/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/login_auth/authorise2farequest/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/login_auth/get2farequest/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/login_auth/keepalive/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/login_auth/login1/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/login_auth/logout1/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/login_auth/pinreset/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/login_auth/rotatehmac/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/login_auth/sessionauth/', level: 3},
|
|
|
|
{slug: 'tricore_architecture/server_interface/account_commands/', level: 2},
|
|
{slug: 'tricore_architecture/server_interface/account_commands/addaddress/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/account_commands/addcard/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/account_commands/changepassword/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/account_commands/changepin/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/account_commands/deleteaccount/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/account_commands/deleteaddress/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/account_commands/gettransactiondetail/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/account_commands/gettransactionhistory/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/account_commands/listaccounts/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/account_commands/listaddresses/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/account_commands/setaccountaddress/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/account_commands/setdefaultaccount/', level: 3},
|
|
|
|
{slug: 'tricore_architecture/server_interface/payment_commands/', level: 2},
|
|
{slug: 'tricore_architecture/server_interface/payment_commands/cancelpaymentrequest/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/payment_commands/confirmtransaction/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/payment_commands/gettransactionupdate/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/payment_commands/paycoderequest/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/payment_commands/redeempaycode/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/payment_commands/refundtransaction/', level: 3},
|
|
|
|
{slug: 'tricore_architecture/server_interface/invoice_commands/', level: 2},
|
|
{slug: 'tricore_architecture/server_interface/invoice_commands/confirm_invoice/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/invoice_commands/get_invoice/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/invoice_commands/list_invoices/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/invoice_commands/reject_invoice/', level: 3},
|
|
|
|
{slug: 'tricore_architecture/server_interface/image_commands/', level: 2},
|
|
{slug: 'tricore_architecture/server_interface/image_commands/addimage/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/image_commands/getimage/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/image_commands/iconcache/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/image_commands/imagecache/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/image_commands/reportimage/', level: 3},
|
|
|
|
{slug: 'tricore_architecture/server_interface/merchant_commands/', level: 2},
|
|
{slug: 'tricore_architecture/server_interface/merchant_commands/list_items/', level: 3},
|
|
|
|
{slug: 'tricore_architecture/server_interface/messaging_commands/', level: 2},
|
|
{slug: 'tricore_architecture/server_interface/messaging_commands/deletemessage/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/messaging_commands/getmessage/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/messaging_commands/listmessages/', level: 3},
|
|
{slug: 'tricore_architecture/server_interface/messaging_commands/markmessage/', level: 3},
|
|
|
|
{slug: 'tricore_architecture/logging/errorcodes/', level: 2},
|
|
|
|
{slug: 'webconsole/overview/', level: 1}
|
|
],
|
|
watch: './docs/wiki/*'
|
|
},
|
|
|
|
//
|
|
// Configuration of the index generator
|
|
//
|
|
indexdocs: {
|
|
src: './docs/',
|
|
dest: './docs/',
|
|
indexPath: 'index.adoc',
|
|
fileDestRelative: './wiki/files',
|
|
options: {
|
|
dest: './docs/',
|
|
|
|
pages: {
|
|
index: './tools/alldocs/templates/adoc-index.handlebars'
|
|
},
|
|
templates: {
|
|
}
|
|
},
|
|
watch: [
|
|
'./tools/alldocs/templates/*',
|
|
'./tools/docgen/templates/*',
|
|
'./swagger_api/api_swagger_def.json'
|
|
]
|
|
}
|
|
};
|
|
|
|
return config;
|
|
};
|