feat: items list restful api.

This commit is contained in:
Ahmed Bouhuolia
2020-03-24 16:47:35 +02:00
parent 2ab714127a
commit 1894ad3b18
10 changed files with 371 additions and 43 deletions

View File

@@ -33,4 +33,13 @@ export default {
column: 'code',
},
},
'items': {
'type': {
column: 'type',
},
'name': {
column: 'name',
},
}
};

View File

@@ -91,14 +91,17 @@ factory.define('item_metadata', 'items_metadata', async () => {
factory.define('item', 'items', async () => {
const category = await factory.create('item_category');
const account = await factory.create('account');
const costAccount = await factory.create('account');
const sellAccount = await factory.create('account');
const inventoryAccount = await factory.create('account');
return {
name: faker.lorem.word(),
note: faker.lorem.paragraph(),
cost_price: faker.random.number(),
sell_price: faker.random.number(),
cost_account_id: account.id,
sell_account_id: account.id,
cost_account_id: costAccount.id,
sell_account_id: sellAccount.id,
inventory_account_id: inventoryAccount.id,
category_id: category.id,
};
});

View File

@@ -10,6 +10,7 @@ exports.up = function (knex) {
table.string('picture_uri');
table.integer('cost_account_id').unsigned();
table.integer('sell_account_id').unsigned();
table.integer('inventory_account_id').unsigned();
table.text('note').nullable();
table.integer('category_id').unsigned();
table.integer('user_id').unsigned();

View File

@@ -287,7 +287,6 @@ export default {
if (viewConditionals.length > 0) {
builder.modify('viewRolesBuilder', viewConditionals, view.rolesLogicExpression);
}
// Build filter query.
if (filter.filter_roles.length > 0) {
filterRoles.buildQuery()(builder);

View File

@@ -1,5 +1,5 @@
import express from 'express';
import { check, oneOf, validationResult } from 'express-validator';
import { check, query, oneOf, validationResult } from 'express-validator';
import moment from 'moment';
import { difference } from 'lodash';
import asyncMiddleware from '@/http/middleware/asyncMiddleware';
@@ -10,8 +10,12 @@ import ItemCategory from '@/models/ItemCategory';
import Resource from '@/models/Resource';
import ResourceField from '@/models/ResourceField';
import Authorization from '@/http/middleware/authorization';
import View from '@/models/View';
import {
mapViewRolesToConditionals,
validateViewRoles,
} from '@/lib/ViewRolesBuilder';
import FilterRoles from '@/lib/FilterRoles';
export default {
@@ -38,9 +42,9 @@ export default {
// this.getCategory.validation,
// asyncMiddleware(this.getCategory.handler));
// router.get('/',
// this.categoriesList.validation,
// asyncMiddleware(this.categoriesList.validation));
router.get('/',
this.listItems.validation,
asyncMiddleware(this.listItems.handler));
return router;
},
@@ -248,47 +252,100 @@ export default {
* Retrive the list items with pagination meta.
*/
listItems: {
validation: [],
validation: [
query('column_sort_order').optional().isIn(['created_at', 'name', 'amount', 'sku']),
query('sort_order').optional().isIn(['desc', 'asc']),
query('page').optional().isNumeric().toInt(),
query('page_size').optional().isNumeric().toInt(),
query('custom_view_id').optional().isNumeric().toInt(),
query('stringified_filter_roles').optional().isJSON(),
],
async handler(req, res) {
const validationErrors = validationResult(req);
if (!validationErrors.isEmpty()) {
return res.boom.badData(null, {
code: 'validation_error', ...validationErrors,
});
}
const errorReasons = [];
const viewConditions = [];
const itemsResource = await Resource.query()
.where('name', 'items')
.withGraphFetched('fields')
.first();
if (!itemsResource) {
return res.status(400).send({ errors: [
{type: 'ITEMS_RESOURCE_NOT_FOUND', code: 200},
]});
}
const filter = {
name: '',
description: '',
SKU: '',
account_id: null,
page_size: 10,
column_sort_order: 'created_at',
sort_order: '',
page: 1,
start_date: null,
end_date: null,
page_size: 10,
custom_view_id: null,
filter_roles: [],
...req.query,
};
if (filter.stringified_filter_roles) {
filter.filter_roles = JSON.parse(filter.stringified_filter_roles);
}
const items = await Item.query((query) => {
if (filter.description) {
query.where('description', 'like', `%${filter.description}%`);
const view = await View.query().onBuild((builder) => {
if (filter.custom_view_id) {
builder.where('id', filter.custom_view_id);
} else {
builder.where('favourite', true);
}
if (filter.description) {
query.where('SKU', filter.SKY);
}
if (filter.name) {
query.where('name', filter.name);
}
if (filter.start_date) {
const startDateFormatted = moment(filter.start_date).format('YYYY-MM-DD HH:mm:SS');
query.where('created_at', '>=', startDateFormatted);
}
if (filter.end_date) {
const endDateFormatted = moment(filter.end_date).format('YYYY-MM-DD HH:mm:SS');
query.where('created_at', '<=', endDateFormatted);
}
}).fetchPage({
page_size: filter.page_size,
page: filter.page,
builder.where('resource_id', itemsResource.id);
builder.withGraphFetched('roles.field');
builder.withGraphFetched('columns');
builder.first();
});
if (view && view.roles.length > 0) {
viewConditions.push(
...mapViewRolesToConditionals(view.roles),
);
if (!validateViewRoles(viewConditions, view.rolesLogicExpression)) {
errorReasons.push({ type: 'VIEW.LOGIC.EXPRESSION.INVALID', code: 400 });
}
}
const filterConditions = new FilterRoles(Item.tableName,
filter.filter_roles.map((role) => ({ ...role, columnKey: role.fieldKey })),
itemsResource.fields,
);
if (filterConditions.validateFilterRoles().length > 0) {
errorReasons.push({ type: 'ITEMS.RESOURCE.HAS.NO.FIELDS', code: 500 });
}
if (errorReasons.length > 0) {
return res.status(400).send({ errors: errorReasons });
}
const items = await Item.query().onBuild((builder) => {
builder.withGraphFetched('costAccount');
builder.withGraphFetched('sellAccount');
builder.withGraphFetched('inventoryAccount');
builder.withGraphFetched('category');
builder.modify('sortBy', filter.column_sort_order, filter.sort_order);
if (viewConditions.length > 0) {
builder.modify('viewRolesBuilder', viewConditions, view.rolesLogicExpression);
}
if (filter.filter_roles.length > 0) {
filterConditions.buildQuery()(builder);
}
}).page(filter.page - 1, filter.page_size);
return res.status(200).send({
items: items.toJSON(),
pagination: items.pagination,
items,
...(view) && {
customViewId: view.id,
viewColumns: view.columns,
viewConditions,
},
});
},
},
};
};

View File

@@ -1,6 +1,9 @@
import { Model } from 'objection';
import path from 'path';
import BaseModel from '@/models/Model';
import {
buildFilterQuery,
} from '@/lib/ViewRolesBuilder';
export default class Item extends BaseModel {
/**
@@ -10,10 +13,26 @@ export default class Item extends BaseModel {
return 'items';
}
static get modifiers() {
const TABLE_NAME = Item.tableName;
return {
sortBy(query, columnSort, sortDirection) {
query.orderBy(columnSort, sortDirection);
},
viewRolesBuilder(query, conditions, logicExpression) {
buildFilterQuery(Item.tableName, conditions, logicExpression)(query);
},
};
}
/**
* Relationship mapping.
*/
static get relationMappings() {
const Account = require('@/models/Account');
const ItemCategory = require('@/models/ItemCategory');
return {
/**
* Item may has many meta data.
@@ -32,12 +51,39 @@ export default class Item extends BaseModel {
*/
category: {
relation: Model.BelongsToOneRelation,
modelBase: path.join(__dirname, 'ItemCategory'),
modelClass: ItemCategory.default,
join: {
from: 'items.categoryId',
to: 'items_categories.id',
},
},
costAccount: {
relation: Model.BelongsToOneRelation,
modelClass: Account.default,
join: {
from: 'items.costAccountId',
to: 'accounts.id',
},
},
sellAccount: {
relation: Model.BelongsToOneRelation,
modelClass: Account.default,
join: {
from: 'items.sellAccountId',
to: 'accounts.id',
},
},
inventoryAccount: {
relation: Model.BelongsToOneRelation,
modelClass: Account.default,
join: {
from: 'items.inventoryAccountId',
to: 'accounts.id',
},
},
};
}
}