Fix/update endpoint and service scaffold

scaffold/endpoint/persistence/mongoose/{{{scaffold_entity_capitalise}}}/model.ts

@@ -10,14 +10,18 @@ interface {{{scaffold_entity_capitalise}}}Fields extends Persistable {
 
 export interface {{{scaffold_entity_capitalise}}}I extends {{{scaffold_entity_capitalise}}}Fields, Document {}
 
-export const {{{scaffold_entity_capitalise}}}Schema: Schema = new Schema(
+export const {{{scaffold_entity_capitalise}}}Schema = new Schema(
   {
     name: { type: String, lowercase: true, trim: true, required: true },
     meta: { type: MetaSchema },
   },
   DefaultSchemaOptions,
 );
 
+{{{scaffold_entity_capitalise}}}Schema.virtual('links').get(function() {
+  return { self: { href: `/${this.id}` } };
+});
+
 {{{scaffold_entity_capitalise}}}Schema.index({ 'meta.created': -1 });
 {{{scaffold_entity_capitalise}}}Schema.index({ 'meta.updated': -1 });
 

scaffold/endpoint/persistence/mongoose/{{{scaffold_entity_capitalise}}}/queries.test.ts

@@ -3,6 +3,7 @@ import { factory } from 'factory-girl';
 import '../../../../test/factories/{{{scaffold_factory}}}';
 import queries from './queries';
 import  { configFiles } from '../../../utils/loadconfig';
+import { verify{{{scaffold_entity_capitalise}}}, verifyResponse } from '../../../../test/helpers/accounts';
 
 import { mongooseConnect, dbConfig as config } from '@ctt/crud-api';
 

scaffold/endpoint/persistence/mongoose/{{{scaffold_entity_capitalise}}}/queries.ts

@@ -8,7 +8,7 @@ import { QueryArgs, DbClient, Query } from '@ctt/crud-api';
 const create = async ({ payload }: QueryArgs): Promise<{{{scaffold_entity_capitalise}}}I> => {
   const {{{scaffold_entity}}} = new {{{scaffold_entity_capitalise}}}({
     ...payload,
-    meta: { ...payload.meta, ...{ created: timezone.parse(Date.now(), intl.tz.LB) } },
+    meta: { ...payload.meta, ...{ created: timezone.parse(Date.now(), intl.tz.WAT) } },
   });
 
   return (await {{{scaffold_entity}}}.save()).toObject();
@@ -23,6 +23,7 @@ const findAll = async ({ payload }: QueryArgs): Promise<PaginateResult<{{{scaffo
           $gte: path(['from'], payload),
           $lte: path(['to'], payload),
         },
+        'meta.active': true,
       }),
     },
     {
@@ -36,26 +37,24 @@ const findAll = async ({ payload }: QueryArgs): Promise<PaginateResult<{{{scaffo
   );
 
 const findById = async ({ payload }: QueryArgs): Promise<{{{scaffold_entity_capitalise}}}I> =>
-  {{{scaffold_entity_capitalise}}}.findById(payload.id).lean({ virtuals: true });
+  {{{scaffold_entity_capitalise}}}.findOne({ _id: payload.id, 'meta.active': true }).lean({ virtuals: true });
 
 const removeById = async ({ payload }: QueryArgs): Promise<object> =>
   {{{scaffold_entity_capitalise}}}.updateOne(
-    { _id: payload.id },
-    { $set: { 'meta.active': false, 'meta.updated': Date.now() } },
+    { _id: payload.id, 'meta.active': true },
+    { $set: { 'meta.active': false, 'meta.updated': timezone.parse(Date.now(), intl.tz.WAT) } },
   );
 
 const updateById = async ({ payload }: QueryArgs): Promise<object> =>
   {{{scaffold_entity_capitalise}}}.updateOne(
-    { _id: payload.id },
+    { _id: payload.id, 'meta.active': true },
     {
-      ...pickBy(val => !!val, {
-        ...payload,
-        ...{
-          $set: {
-            'meta.updated': Date.now(),
-          },
-        },
-      }),
+      $set: {
+        ...pickBy(val => !!val, {
+          ...payload,
+          'meta.updated': timezone.parse(Date.now(), intl.tz.WAT),
+        }),
+      },
     },
   );
 

scaffold/endpoint/{{{scaffold_entities}}}/routes.test.ts

@@ -102,18 +102,18 @@ describe(`Routes: ${ROUTE_NAME}`, () => {
       mockContentType.mockImplementation(() => mockResponse);
       mockRequest = {
         log: jest.fn(),
-        params: jest.fn().mockReturnValue({ {{{scaffold_entity}}}Id: uid }),
+        params: jest.fn().mockReturnValue({ {{{scaffold_entity_route_id}}}: uid }),
       };
     });
 
     it(`sets HTTP method GET on /${ROUTE_NAME} path`, () => {
       expect(router.method).toBe('GET');
-      expect(router.path).toBe(`/${ROUTE_NAME}/{{{{scaffold_entity}}}Id}`);
+      expect(router.path).toBe(`/${ROUTE_NAME}/{{{scaffold_entity_route_id}}}`);
     });
 
     it('sets validation on request params', () => {
       const { params } = router.options.validate;
-      expect(params.{{{scaffold_entity}}}Id).toBeDefined();
+      expect(params.{{{scaffold_entity_route_id}}}).toBeDefined();
     });
 
     it(`sets response HTTP status code to ${statusCode} on success`, async () => {
@@ -159,18 +159,18 @@ describe(`Routes: ${ROUTE_NAME}`, () => {
       mockStatusCode.mockImplementation(() => mockResponse);
       mockRequest = {
         log: jest.fn(),
-        params: jest.fn().mockReturnValue({ {{{scaffold_entity}}}Id: uid }),
+        params: jest.fn().mockReturnValue({ {{{scaffold_entity_route_id}}}: uid }),
       };
     });
 
     it(`sets HTTP method DELETE on /${ROUTE_NAME} path`, () => {
       expect(router.method).toBe('DELETE');
-      expect(router.path).toBe(`/${ROUTE_NAME}/{{{{scaffold_entity}}}Id}`);
+      expect(router.path).toBe(`/${ROUTE_NAME}/{{{scaffold_entity_route_id}}}`);
     });
 
     it('sets validation on request params', () => {
       const { params } = router.options.validate;
-      expect(params.{{{scaffold_entity}}}Id).toBeDefined();
+      expect(params.{{{scaffold_entity_route_id}}}).toBeDefined();
     });
 
     it(`sets response HTTP status code to ${statusCode} on success`, async () => {
@@ -189,7 +189,7 @@ describe(`Routes: ${ROUTE_NAME}`, () => {
     });
   });
 
-  describe(`PATCH /${ROUTE_NAME}`, () => {
+  describe(`PUT /${ROUTE_NAME}`, () => {
     const router: any = update{{{scaffold_entity_capitalise}}}({ services, validate }); // eslint-disable-line @typescript-eslint/no-explicit-any
     const responseData = '{{{scaffold_entity_capitalise}}} entry modified';
     const statusCode = 200;
@@ -211,20 +211,20 @@ describe(`Routes: ${ROUTE_NAME}`, () => {
       mockStatusCode.mockImplementation(() => mockResponse);
       mockRequest = {
         log: jest.fn(),
-        params: jest.fn().mockReturnValue({ {{{scaffold_entity}}}Id: uid }),
+        params: jest.fn().mockReturnValue({ {{{scaffold_entity_route_id}}}: uid }),
         payload: jest.fn().mockReturnValue({}),
       };
     });
 
-    it(`sets HTTP method PATCH on /${ROUTE_NAME} path`, () => {
-      expect(router.method).toBe('PATCH');
-      expect(router.path).toBe(`/${ROUTE_NAME}/{{{{scaffold_entity}}}Id}`);
+    it(`sets HTTP method PUT on /${ROUTE_NAME} path`, () => {
+      expect(router.method).toBe('PUT');
+      expect(router.path).toBe(`/${ROUTE_NAME}/{{{scaffold_entity_route_id}}}`);
     });
 
     it('sets validation on request payload and params', () => {
       const { payload } = router.options.validate;
       const { params } = router.options.validate;
-      expect(params.{{{scaffold_entity}}}Id).toBeDefined();
+      expect(params.{{{scaffold_entity_route_id}}}).toBeDefined();
       expect(payload).toBeDefined();
     });
 

scaffold/endpoint/{{{scaffold_entities}}}/routes.ts

@@ -92,7 +92,7 @@ export default ({ services, config, json, validate }: RouteArgs): ServerRoute =>
 
 export const find{{{scaffold_entity_capitalise}}} = ({ services, validate, json, config }: RouteArgs): ServerRoute => ({
   method: 'GET',
-  path: '/{{{scaffold_entities}}}/{{{{scaffold_entity}}}Id}',
+  path: '/{{{scaffold_entities}}}/{{{scaffold_entity_route_id}}}',
   options: {
     ...service.options.secureOption,
     validate: {
@@ -112,14 +112,14 @@ export const find{{{scaffold_entity_capitalise}}} = ({ services, validate, json,
           .takeover();
       },
       params: {
-        {{{scaffold_entity}}}Id: validateObjectId(validate),
+        {{{scaffold_entity_id}}}: validateObjectId(validate),
       },
     },
 
     tags: ['{{{scaffold_entities}}}'],
   },
   handler: async (request, h): Promise<ResponseObject> => {
-    const payload = { id: request.params.{{{scaffold_entity}}}Id };
+    const payload = { id: request.params.{{{scaffold_entity_id}}} };
     request.log([`/${ROUTE_NAME}`]);
     let response;
 
@@ -213,7 +213,7 @@ export const findAll{{{scaffold_entity_capitalise}}}s = ({ services, validate, c
 
 export const remove{{{scaffold_entity_capitalise}}} = ({ services, validate, config, json }: RouteArgs): ServerRoute => ({
   method: 'DELETE',
-  path: '/{{{scaffold_entities}}}/{{{{scaffold_entity}}}Id}',
+  path: '/{{{scaffold_entities}}}/{{{scaffold_entity_route_id}}}',
   options: {
     ...service.options.secureOption,
     validate: {
@@ -233,14 +233,14 @@ export const remove{{{scaffold_entity_capitalise}}} = ({ services, validate, con
           .takeover();
       },
       params: {
-        {{{scaffold_entity}}}Id: validateObjectId(validate),
+        {{{scaffold_entity_id}}}: validateObjectId(validate),
       },
     },
 
     tags: ['{{{scaffold_entities}}}'],
   },
   handler: async (request, h): Promise<ResponseObject> => {
-    const payload = { id: request.params.{{{scaffold_entity}}}Id };
+    const payload = { id: request.params.{{{scaffold_entity_id}}} };
     request.log([`/${ROUTE_NAME}`]);
     let response;
 
@@ -263,8 +263,8 @@ export const remove{{{scaffold_entity_capitalise}}} = ({ services, validate, con
 });
 
 export const update{{{scaffold_entity_capitalise}}} = ({ services, validate, config, json }: RouteArgs): ServerRoute => ({
-  method: 'PATCH',
-  path: '/{{{scaffold_entities}}}/{{{{scaffold_entity}}}Id}',
+  method: 'PUT',
+  path: '/{{{scaffold_entities}}}/{{{scaffold_entity_route_id}}}',
   options: {
     ...service.options.secureOption,
     validate: {
@@ -284,7 +284,7 @@ export const update{{{scaffold_entity_capitalise}}} = ({ services, validate, con
           .takeover();
       },
       params: {
-        {{{scaffold_entity}}}Id: validateObjectId(validate),
+        {{{scaffold_entity_id}}}: validateObjectId(validate),
       },
       payload: makeRequestPayloadSchema(validate),
     },
@@ -294,7 +294,7 @@ export const update{{{scaffold_entity_capitalise}}} = ({ services, validate, con
   handler: async (request, h): Promise<ResponseObject> => {
     const payload = {
       ...(request.payload as object),
-      id: request.params.{{{scaffold_entity}}}Id,
+      id: request.params.{{{scaffold_entity_id}}},
     };
     request.log([`/${ROUTE_NAME}`]);
     let response;

scaffold/endpoint/{{{scaffold_entities}}}/services.ts

@@ -1,5 +1,6 @@
 import tmplJson from './parsers/json';
 import { Dict, Crud, ServiceArgs } from '@ctt/crud-api';
+import { pickBy } from 'ramda';
 import { {{{scaffold_entity_capitalise}}}I } from '../persistence/mongoose/{{{scaffold_entity_capitalise}}}/model';
 import { PaginateResult } from 'mongoose';
 import { responseDocumentSchema, createPaginationLink } from '../utils/schemas';

scaffold/endpoint/{{{scaffold_entities}}}/{{{scaffold_entities}}}.test.ts

@@ -19,7 +19,7 @@ let app = null;
 const url =  `/${ROUTE_NAME}`;
 let headers = null;
 
-describe('Users', () => {
+describe('{{{scaffold_entities_capitalized}}}', () => {
   beforeAll(async () => {
     app = await application();
     await app.start();

scaffold/service/nodemon.json

@@ -3,6 +3,6 @@
   "env": {
     "NODE_ENV": "development"
   },
-  "ext": "ts",
+  "ext": "ts,js,json",
   "exec": "ts-node -- src/index.ts"
 }

scaffold/service/package.json.replace

@@ -55,8 +55,8 @@
   },
   "dependencies": {
     "@ctt/crud-api": "1.6.27",
-    "@ctt/redis-client": "0.0.0-beta.5",
-    "@ctt/service-utils": "1.3.11",
+    "@ctt/redis-client": "0.0.1",
+    "@ctt/service-utils": "1.3.22",
     "convict": "4.3.2",
     "dotenv": "6.0.0",
     "hapi-auth-jwt2": "8.1.0",

scaffold/service/src/utils/schemas.ts

@@ -40,7 +40,7 @@ export const errorResponseSchema = {
   },
 };
 
-const link = {
+const paginationLink = {
   type: 'object',
   properties: {
     href: {
@@ -49,6 +49,20 @@ const link = {
   },
 };
 
+const links = {
+  type: 'object',
+  properties: {
+    self: {
+      type: 'object',
+      properties: {
+        href: {
+          type: 'string',
+        },
+      },
+    },
+  },
+};
+
 export const paginationResponseSchema = {
   pagination: {
     type: 'object',
@@ -62,11 +76,11 @@ export const paginationResponseSchema = {
         type: 'integer',
         format: 'int32',
       },
-      first: link,
-      last: link,
-      next: link,
-      current: link,
-      previous: link,
+      first: paginationLink,
+      last: paginationLink,
+      next: paginationLink,
+      current: paginationLink,
+      previous: paginationLink,
     },
   },
 };
@@ -92,6 +106,7 @@ export const responseDocumentSchema = (template): object => ({
           id: {
             type: 'string',
           },
+          links,
           ...metaResponseSchema,
         },
       },
@@ -101,12 +116,13 @@ export const responseDocumentSchema = (template): object => ({
   },
 });
 
-export const validateObjectId = (validator: Root): StringSchema => validator.string().regex(/\b[0-9a-fA-F]{24}\b/);
+export const validateObjectId = (validator: Root): StringSchema =>
+  validator.string().regex(/\b[0-9a-fA-F]{24}\b/);
 
 export const createPaginationLink = (endpoint: string): Function => (
   page: number,
   limit?: number,
-  offset?: number
+  offset?: number,
 ): object => ({
   href: `/${endpoint}?page=${page}&limit=${limit}${offset ? `&offset=${offset}` : ''}`,
 });