@kravc/dos 1.11.19 → 1.11.21

package/examples/ReadProfile.js

@@ -3,4 +3,16 @@
 const Read    = require('../src/operations/Read')
 const Profile = require('./Profile')
 
-module.exports = Read(Profile)
+class ReadProfile extends Read(Profile) {
+  static get query() {
+    return {
+      id: {
+        description: 'Profile ID',
+        required: true,
+        example: 'PRO_1'
+      }
+    }
+  }
+}
+
+module.exports = ReadProfile

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kravc/dos",
-  "version": "1.11.19",
+  "version": "1.11.21",
   "description": "Convention-based, easy-to-use library for building API-driven serverless services.",
   "keywords": [
     "Service",

package/src/Document.js

@@ -9,6 +9,8 @@ const DocumentNotFoundError = require('./errors/DocumentNotFoundError')
 const { get, omit, capitalize, cloneDeep } = require('lodash')
 
 const STORE = {}
+const SYSTEM = 'SYSTEM'
+const IDENTITY_SUBJECT_PATH = 'identity.sub'
 
 class Document extends Component {
   static get idKey() {
@@ -33,10 +35,10 @@ class Document extends Component {
     return this._schema
   }
 
-  static set schema(schema) {
+  static get _defaultSchemaProperties() {
     const documentTitle = getComponentTitle(this, false)
 
-    this._schema = schema.extend({
+    return {
       id: {
         description: capitalize(documentTitle) + ' ID',
         required:    true
@@ -56,8 +58,11 @@ class Document extends Component {
       updatedBy: {
         description: `ID of a user who updated ${documentTitle}`
       }
-    }, this.id)
+    }
+  }
 
+  static set schema(schema) {
+    this._schema = schema.extend(this._defaultSchemaProperties, this.id)
     this._bodySchema = schema
   }
 
@@ -69,6 +74,13 @@ class Document extends Component {
     parameters.partition = this.getPartition(context, parameters)
   }
 
+  static _extendWithCreateStamps(mutation) {
+    const timestamp = new Date().toJSON()
+    mutation.createdAt = timestamp
+    mutation.updatedAt = timestamp
+    mutation.createdBy = get(context, IDENTITY_SUBJECT_PATH, SYSTEM)
+  }
+
   static async create(context, query, mutation) {
     /* NOTE: existing document in the context allows to return document without
              duplicate been created */
@@ -89,15 +101,7 @@ class Document extends Component {
     const { validator } = context
     mutation = validator.normalize(mutation, this.id)
 
-    const identitySubjectId = get(context, 'identity.sub')
-
-    if (identitySubjectId) {
-      mutation.createdBy = identitySubjectId
-    }
-
-    const timestamp = new Date().toJSON()
-    mutation.createdAt = timestamp
-    mutation.updatedAt = timestamp
+    this._extendWithCreateStamps(mutation)
 
     if (this.beforeCreate) {
       await this.beforeCreate(context, query, mutation)
@@ -189,17 +193,16 @@ class Document extends Component {
     return this._index(query)
   }
 
+  static _extendWithUpdateStamps(mutation) {
+    const timestamp = new Date().toJSON()
+    mutation.updatedAt = timestamp
+    mutation.updatedBy = get(context, IDENTITY_SUBJECT_PATH, SYSTEM)
+  }
+
   static async update(context, query, mutation, originalDocument = null) {
     mutation = omit(mutation, [ this.idKey, 'createdAt', 'createdBy' ])
 
-    const identitySubjectId = get(context, 'identity.sub')
-
-    if (identitySubjectId) {
-      mutation.updatedBy = identitySubjectId
-    }
-
-    const timestamp = new Date().toJSON()
-    mutation.updatedAt = timestamp
+    this._extendWithUpdateStamps(mutation)
 
     if (this.beforeUpdate) {
       await this.beforeUpdate(context, query, mutation)

package/src/Document.spec.js

@@ -58,14 +58,14 @@ describe('Document', () => {
       expect(profile.attributes.name).to.eql('Olga')
     })
 
-    it('creates document without identity in context', async () => {
+    it('creates document without identity in context as SYSTEM', async () => {
       const context = { validator }
       const profile = await Profile.create(context, { name: 'Oleg' })
 
       expect(profile.id).to.exist
       expect(profile.attributes.name).to.eql('Oleg')
       expect(profile.attributes.createdAt).to.exist
-      expect(profile.attributes.createdBy).to.not.exist
+      expect(profile.attributes.createdBy).to.eql('SYSTEM')
     })
 
     it('returns exiting document from the context', async () => {
@@ -115,14 +115,14 @@ describe('Document', () => {
       expect(profile.attributes.updatedBy).to.exist
     })
 
-    it('updates document without identity in context', async () => {
+    it('updates document without identity in context as SYSTEM', async () => {
       const context = { validator }
       const { id } = await Profile.create(context, { name: 'Gustav' })
 
       const profile = await Profile.update(context, { id }, { name: 'Jack' })
 
       expect(profile.attributes.updatedAt).to.exist
-      expect(profile.attributes.updatedBy).to.not.exist
+      expect(profile.attributes.updatedBy).to.eql('SYSTEM')
     })
 
     it('throws "DocumentNotFoundError" if document not found', async () => {

package/src/helpers/createSpec.js

@@ -80,7 +80,11 @@ const createSpec = (operations, schemasMap, url) => {
 
     for (const name in query) {
       const queryParameter = { in: 'query', name, type: 'string', ...query[name] }
-      delete queryParameter.example
+
+      if (queryParameter.example) {
+        queryParameter['x-example'] = queryParameter.example
+        delete queryParameter.example
+      }
 
       parameters.push(queryParameter)
     }