@kravc/dos 1.11.22 → 1.12.1

package/package.json

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

package/src/Document.js

@@ -1,12 +1,13 @@
 'use strict'
 
-const { ulid }              = require('ulid')
+const { ulid } = require('ulid')
+const { get, omit, cloneDeep } = require('lodash')
+
 const Component             = require('./Component')
 const getIdPrefix           = require('./helpers/getIdPrefix')
-const getComponentTitle     = require('./helpers/getComponentTitle')
 const DocumentExistsError   = require('./errors/DocumentExistsError')
 const DocumentNotFoundError = require('./errors/DocumentNotFoundError')
-const { get, omit, capitalize, cloneDeep } = require('lodash')
+const getDefaultSchemaAttributes = require('./helpers/getDefaultSchemaAttributes')
 
 const STORE = {}
 const SYSTEM = 'SYSTEM'
@@ -35,34 +36,12 @@ class Document extends Component {
     return this._schema
   }
 
-  static get _defaultSchemaProperties() {
-    const documentTitle = getComponentTitle(this, false)
-
-    return {
-      id: {
-        description: capitalize(documentTitle) + ' ID',
-        required:    true
-      },
-      createdAt: {
-        description: `Date and time when ${documentTitle} was created`,
-        format:      'date-time',
-        required:    true
-      },
-      updatedAt: {
-        description: `Date and time when ${documentTitle} was updated`,
-        format:      'date-time'
-      },
-      createdBy: {
-        description: `ID of a user who created ${documentTitle}`
-      },
-      updatedBy: {
-        description: `ID of a user who updated ${documentTitle}`
-      }
-    }
+  static get _defaultSchemaAttributes() {
+    return getDefaultSchemaAttributes(this)
   }
 
   static set schema(schema) {
-    this._schema = schema.extend(this._defaultSchemaProperties, this.id)
+    this._schema = schema.extend(this._defaultSchemaAttributes, this.id)
     this._bodySchema = schema
   }
 
@@ -74,10 +53,9 @@ class Document extends Component {
     parameters.partition = this.getPartition(context, parameters)
   }
 
-  static _extendWithCreateStamps(context, mutation) {
+  static _extendWithCreatedStamps(context, mutation) {
     const timestamp = new Date().toJSON()
     mutation.createdAt = timestamp
-    mutation.updatedAt = timestamp
     mutation.createdBy = get(context, IDENTITY_SUBJECT_PATH, SYSTEM)
   }
 
@@ -101,7 +79,7 @@ class Document extends Component {
     const { validator } = context
     mutation = validator.normalize(mutation, this.id)
 
-    this._extendWithCreateStamps(context, mutation)
+    this._extendWithCreatedStamps(context, mutation)
 
     if (this.beforeCreate) {
       await this.beforeCreate(context, query, mutation)
@@ -193,7 +171,7 @@ class Document extends Component {
     return this._index(query)
   }
 
-  static _extendWithUpdateStamps(context, mutation) {
+  static _extendWithUpdatedStamps(context, mutation) {
     const timestamp = new Date().toJSON()
     mutation.updatedAt = timestamp
     mutation.updatedBy = get(context, IDENTITY_SUBJECT_PATH, SYSTEM)
@@ -202,7 +180,7 @@ class Document extends Component {
   static async update(context, query, mutation, originalDocument = null) {
     mutation = omit(mutation, [ this.idKey, 'createdAt', 'createdBy' ])
 
-    this._extendWithUpdateStamps(context, mutation)
+    this._extendWithUpdatedStamps(context, mutation)
 
     if (this.beforeUpdate) {
       await this.beforeUpdate(context, query, mutation)
@@ -243,17 +221,17 @@ class Document extends Component {
   }
 
   static async delete(context, query) {
-    if (this.beforeDelete) {
-      await this.beforeDelete(context, query)
-    }
-
     /* NOTE: ensure that document to be removed exists and save it in the
              context so can be referenced in the after action helper */
     const originalDocument = await this.read(context, query)
 
+    if (this.beforeDelete) {
+      await this.beforeDelete(context, query, originalDocument)
+    }
+
     this._extendWithPartition(context, query)
 
-    await this._delete(query, context)
+    await this._delete(context, query)
 
     if (this.afterDelete) {
       await this.afterDelete(context, query, originalDocument)
@@ -262,7 +240,7 @@ class Document extends Component {
     return originalDocument
   }
 
-  static _delete({ id }) {
+  static _delete(context, { id }) {
     const item = STORE[this.name][id]
 
     /* istanbul ignore next: not used anymore by delete interface as read

package/src/helpers/getDefaultSchemaAttributes.js

@@ -0,0 +1,32 @@
+'use strict'
+
+const { capitalize } = require('lodash')
+const getComponentTitle = require('./getComponentTitle')
+
+const getDefaultSchemaAttributes = (Component) => {
+  const documentTitle = getComponentTitle(Component, false)
+
+  return {
+    id: {
+      description: capitalize(documentTitle) + ' ID',
+      required:    true
+    },
+    createdAt: {
+      description: `Date and time when ${documentTitle} was created`,
+      format:      'date-time',
+      required:    true
+    },
+    updatedAt: {
+      description: `Date and time when ${documentTitle} was updated`,
+      format:      'date-time'
+    },
+    createdBy: {
+      description: `ID of a user who created ${documentTitle}`
+    },
+    updatedBy: {
+      description: `ID of a user who updated ${documentTitle}`
+    }
+  }
+}
+
+module.exports = getDefaultSchemaAttributes

package/src/index.d.ts

@@ -36,8 +36,12 @@ export declare class Document<T> {
   static set schema(schema: Schema);
   static get schema(): Schema;
 
+  static get _defaultSchemaAttributes(): SchemaAttributes;
+
   static _read(query: QueryMap): Promise<AttributesMap>;
+  static _extendWithCreatedStamps(context: Context, mutation: CreateMutationMap): void;
   static _create(attributes: AttributesMap): Promise<Boolean>;
+  static _extendWithUpdatedStamps(context: Context, mutation: UpdateMutationMap): void;
   static _update(query: QueryMap, mutation: UpdateMutationMap): Promise<AttributesMap>;
 
   static createId(attributes: AttributesMap): string;
@@ -100,36 +104,37 @@ export declare class Document<T> {
     mutation: CreateMutationMap
   ): Promise<void>;
 
-  static afterCreate<T, D extends Document<T> = Document<T>>(
-    context: Context,
-    query: QueryMap,
-    mutation: CreateMutationMap,
-    originalDocument: D
-  ): Promise<void>;
-
   static beforeUpdate(
     context: Context,
     query: QueryMap,
     mutation: UpdateMutationMap,
   ): Promise<void>;
 
-  static afterUpdate<T, D extends Document<T> = Document<T>>(
-    context: Context,
-    query: QueryMap,
-    mutation: UpdateMutationMap,
-    originalDocument: D
-  ): Promise<void>;
-
-  static beforeDelete(
-    context: Context,
-    query: QueryMap,
-  ): Promise<void>;
-
-  static afterDelete<T, D extends Document<T> = Document<T>>(
-    context: Context,
-    query: QueryMap,
-    originalDocument: D
-  ): Promise<void>;
+  // static beforeDelete<T, D extends Document<T> = Document<T>>(
+  //   context: Context,
+  //   query: QueryMap,
+  //   originalDocument: D
+  // ): Promise<void>;
+
+  // static afterCreate<T, D extends Document<T> = Document<T>>(
+  //   context: Context,
+  //   query: QueryMap,
+  //   mutation: CreateMutationMap,
+  //   originalDocument: D
+  // ): Promise<void>;
+
+  // static afterUpdate<T, D extends Document<T> = Document<T>>(
+  //   context: Context,
+  //   query: QueryMap,
+  //   mutation: UpdateMutationMap,
+  //   originalDocument: D
+  // ): Promise<void>;
+
+  // static afterDelete<T, D extends Document<T> = Document<T>>(
+  //   context: Context,
+  //   query: QueryMap,
+  //   originalDocument: D
+  // ): Promise<void>;
 
   get id(): string;
   get context(): Context;
@@ -168,14 +173,14 @@ export declare class JwtAuthorization {
     tokenVerificationMethod?: Function;
     accessVerificationMethod?: (context: Context, payload: Record<string, unknown>) => [boolean, string?];
   }): Record<string, any>
-};
+}
 
 export declare class SystemAuthorization {
   static createRequirement(options?: {
     name?: string;
     accessVerificationMethod?: (context: Context) => [boolean, string?];
   }): Record<string, any>
-};
+}
 
 export type ComponentConstructor = new (...args: any[]) => any;
 type OperationConstructor = new (...args: any[]) => any;
@@ -302,31 +307,31 @@ export declare class CommonError extends Error {
   constructor(code: string, message: string);
   get code(): string;
   get isCommonError(): boolean;
-};
+}
 
 export declare class UnauthorizedError extends CommonError {
   constructor(message: string);
-};
+}
 
 export declare class AccessDeniedError extends CommonError {
   constructor(message: string);
-};
+}
 
 export declare class InvalidParametersError extends CommonError {
   constructor(message: string)
-};
+}
 
 export declare class UnprocessibleConditionError extends CommonError {
   constructor(message: string)
-};
+}
 
 export declare class DocumentExistsError extends CommonError {
   constructor(Document: { name: string }, parameters: Record<string, unknown>);
-};
+}
 
 export declare class DocumentNotFoundError extends CommonError {
   constructor(Document: { name: string }, parameters: Record<string, unknown>);
-};
+}
 
 interface Identity {
   sub: string;
@@ -336,3 +341,7 @@ interface Identity {
 export declare function authorize(Operation, Context): Promise<Identity>;
 
 export declare function maskSecrets(object: Record<string, unknown>): Record<string, unknown>;
+
+export declare function getComponentTitle(Component, isCapitalized?: boolean, isPlural?: boolean): string;
+
+export declare function getDefaultSchemaAttributes(Component): SchemaAttributes;

package/src/index.js

@@ -16,6 +16,8 @@ module.exports = {
   getOrFail:                   require('./helpers/getOrFail'),
   authorize:                   require('./helpers/authorize'),
   maskSecrets:                 require('./helpers/maskSecrets'),
+  getComponentTitle:           require('./helpers/getComponentTitle'),
+  getDefaultSchemaAttributes:  require('./helpers/getDefaultSchemaAttributes'),
   security:                    require('./security'),
   verifyToken:                 require('./security/verifyToken'),
   JwtAuthorization:            require('./security/JwtAuthorization'),