@kravc/dos 2.0.0-alpha.0 → 2.0.0-alpha.10

package/dist/Service/errors/OperationError.yaml

@@ -0,0 +1,29 @@
+error:
+  required: true
+
+  properties:
+    code:
+      required: true
+      description: Error code
+
+    message:
+      required: true
+      description: Error message
+
+    statusCode:
+      type: integer
+      required: true
+      description: HTTP error status code
+
+    validationErrors:
+      description: Validation errors
+      items:
+        properties:
+          code:
+            description: Validation error code
+
+          path:
+            description: Path of invalid attribute
+
+          message:
+            description: Validation error message

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kravc/dos",
-  "version": "2.0.0-alpha.0",
+  "version": "2.0.0-alpha.10",
   "description": "Convention-based, easy-to-use library for building API-driven serverless services.",
   "keywords": [
     "Service",
@@ -26,12 +26,13 @@
     "prebuild": "rimraf dist",
     "build": "tsc",
     "prepare": "npm run build",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "postbuild": "cp -r src/Service/errors/*.yaml dist/Service/errors 2>/dev/null || true"
   },
   "author": "Alexander Kravets <a@kra.vc>",
   "license": "ISC",
   "dependencies": {
-    "@kravc/schema": "^2.8.0-alpha.7",
+    "@kravc/schema": "^2.8.0-alpha.8",
     "@types/jsonwebtoken": "^9.0.10",
     "cookie": "^1.1.1",
     "jsonwebtoken": "^9.0.3",
@@ -49,14 +50,14 @@
     "@types/lodash": "^4.17.23",
     "@types/pluralize": "^0.0.33",
     "eslint": "^9.39.2",
-    "eslint-plugin-jsdoc": "^62.4.1",
-    "openapi-types": "^12.1.3",
+    "eslint-plugin-jsdoc": "^62.6.0",
     "globals": "^17.1.0",
     "jest": "^30.2.0",
-    "rimraf": "^6.1.2",
+    "openapi-types": "^12.1.3",
+    "rimraf": "^6.1.3",
     "ts-jest": "^29.4.6",
     "ts-node": "^10.9.2",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.54.0"
+    "typescript-eslint": "^8.56.0"
   }
 }

package/src/Document/Document.ts

@@ -5,23 +5,26 @@ import Context, { type QueryMap, type MutationMap } from '../Context';
 import { get, set, omit, pick, cloneDeep, capitalize } from 'lodash';
 
 const DEFAULT_INDEX_SORT = 'desc';
-const DEFAULT_INDEX_LIMIT = 300;
+const DEFAULT_INDEX_LIMIT = 20;
+const DEFAULT_INDEX_LIMIT_MAX = 100;
+
 const DEFAULT_PARTITION_KEY = 'partition';
 
 export type IndexOptions = {
   sort?: 'asc' | 'desc';
   limit?: number;
-  index?: string;
+  indexName?: string;
   exclusiveStartKey?: string;
 }
 
 export type IndexAllOptions = {
   sort?: 'asc' | 'desc';
-  index?: string;
+  indexName?: string;
 }
 
 export type DefaultAttributes = {
   id: string;
+  partition: string;
   createdAt: string;
   createdBy: string;
   createdByUserName?: string;
@@ -34,6 +37,7 @@ type Constructor<T, D extends Document<T> = Document<T>> = {
   new(context: Context, attributes: T): D;
 
   _index(query: QueryMap, options: IndexOptions): Promise<{
+    limit: number;
     count: number;
     items: T[];
     lastEvaluatedKey?: string;
@@ -46,11 +50,11 @@ type Constructor<T, D extends Document<T> = Document<T>> = {
 
   _read(query: QueryMap, options: unknown): Promise<T>;
 
-  _create(attributes: T): Promise<void>;
+  _create(attributes: T, context?: Context): Promise<void>;
 
-  _update<T>(query: QueryMap, mutation: MutationMap): Promise<T>;
+  _update<T>(query: QueryMap, mutation: MutationMap, context?: Context, previousAttributes?: T): Promise<T>;
 
-  _delete(query: QueryMap): Promise<void>;
+  _delete(query: QueryMap, context?: Context, previousAttributes?: T): Promise<void>;
 };
 
 /** Abstract document class. */
@@ -84,6 +88,11 @@ class Document<Attributes> extends Component<Attributes> {
     return DEFAULT_INDEX_LIMIT;
   }
 
+  /** Defines limit maximum value for index action. */
+  static get indexLimitMax(): number {
+    return DEFAULT_INDEX_LIMIT_MAX;
+  }
+
   /** Generates ID for new document unless it's defined in parameters. */
   static createId(attributes: Record<string, unknown>): string {
     const id = get(attributes, this.idKey) as string;
@@ -196,6 +205,15 @@ class Document<Attributes> extends Component<Attributes> {
     mutation.updatedByUserName = context.identityName;
   }
 
+  /** Extends mutation with deleted stamps. */
+  static _extendWithDeletedStamps(context: Context, mutation: MutationMap) {
+    const timestamp = new Date().toJSON();
+
+    mutation.deletedAt = timestamp;
+    mutation.deletedBy = context.identityId;
+    mutation.deletedByUserName = context.identityName;
+  }
+
   /** Returns documents in batches. */
   static async index<T, D extends Document<T> = Document<T>>(
     this: Constructor<T, D>,
@@ -203,6 +221,7 @@ class Document<Attributes> extends Component<Attributes> {
     query: QueryMap = {},
     options: IndexOptions = {}
   ): Promise<{
+    limit: number;
     count: number;
     objects: D[];
     lastEvaluatedKey?: string;
@@ -218,10 +237,15 @@ class Document<Attributes> extends Component<Attributes> {
       options.sort = _this.indexDefaultSort;
     }
 
-    const { items, count, lastEvaluatedKey, ...otherPagination } = await this._index(query, options);
+    const { count, limit, items, lastEvaluatedKey } = await this._index(query, options);
     const objects = items.map(attributes => new this(context, attributes));
 
-    return { objects, count, lastEvaluatedKey, ...otherPagination };
+    return {
+      limit,
+      count,
+      objects,
+      lastEvaluatedKey,
+    };
   }
 
   /** Returns all documents. */
@@ -299,7 +323,7 @@ class Document<Attributes> extends Component<Attributes> {
 
     await _this.beforeCreate(context, query, attributes);
 
-    await this._create(attributes as T);
+    await this._create(attributes as T, context);
     const object = new this(context, attributes as T);
 
     await _this.afterCreate(context, query, mutation, object);
@@ -349,7 +373,7 @@ class Document<Attributes> extends Component<Attributes> {
       previousAttributes = await this._read(query, {});
     }
 
-    const updatedAttributes = await this._update(query, mutation) as T;
+    const updatedAttributes = await this._update(query, mutation, context, previousAttributes) as T;
     const object = new this(context, updatedAttributes);
 
     object._previousAttributes = previousAttributes;
@@ -383,14 +407,14 @@ class Document<Attributes> extends Component<Attributes> {
 
     await _this.beforeDelete(context, query);
 
-    const attributes = await this._read(query, {});
-    const object = new this(context, attributes);
+    const previousAttributes = await this._read(query, {});
 
-    await this._delete(query);
+    await this._delete(query, context, previousAttributes);
 
-    await _this.afterDelete(context, query, object);
+    const deletedObject = new this(context, previousAttributes);
+    await _this.afterDelete(context, query, deletedObject);
 
-    return object;
+    return deletedObject;
   }
 
   /** Before delete hook. */

package/src/Document/MemoryDocument.ts

@@ -1,5 +1,5 @@
 import { got } from '@kravc/schema';
-import type { QueryMap, MutationMap } from '../Context';
+import Context, { type QueryMap, type MutationMap } from '../Context';
 import { get, set,  last, unset, cloneDeep, sortBy } from 'lodash';
 import { DocumentExistsError, DocumentNotFoundError } from '../Operation';
 import Document, { type IndexOptions, type IndexAllOptions } from './Document';
@@ -11,6 +11,9 @@ type Item = {
 
 const _MEMORY_STORE = {} as Record<string, Record<string, Item>>;
 
+const QUERY_ERROR_TEMPLATE = 'Query parameter "$PATH" is required';
+const ATTRIBUTE_ERROR_TEMPLATE = 'Attribute "$PATH" is required';
+
 /** Example implementation of a document class stored in memory. */
 class MemoryDocument<T> extends Document<T> {
   /** Returns collection where documents are stored. */
@@ -35,6 +38,7 @@ class MemoryDocument<T> extends Document<T> {
 
   /** Implements interface to get documents in batches. */
   static async _index<T>(query: QueryMap, options: IndexOptions): Promise<{
+    limit: number;
     count: number;
     items: T[];
     lastEvaluatedKey?: string;
@@ -81,6 +85,7 @@ class MemoryDocument<T> extends Document<T> {
     }
 
     return {
+      limit: limit || count,
       items,
       count,
       lastEvaluatedKey,
@@ -102,7 +107,7 @@ class MemoryDocument<T> extends Document<T> {
 
   /** Implements interface to get a document. */
   static async _read<T>(query: QueryMap): Promise<T> {
-    const idValue = got(query, this.idKey, 'Query parameter "$PATH" is required') as string;
+    const idValue = got(query, this.idKey, QUERY_ERROR_TEMPLATE) as string;
 
     const item = get(this.collection, idValue) as T;
 
@@ -113,9 +118,10 @@ class MemoryDocument<T> extends Document<T> {
     return cloneDeep(item);
   }
 
-  /** Implements interface to save a document, returns false if document is not created. */
-  static async _create<T>(attributes: T): Promise<void> {
-    const idValue = got(attributes, this.idKey, 'Attribute "$PATH" is required') as string;
+  /** Implements interface to save a document. */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  static async _create<T>(attributes: T, _context: Context): Promise<void> {
+    const idValue = got(attributes, this.idKey, ATTRIBUTE_ERROR_TEMPLATE) as string;
 
     const item = get(this.collection, idValue) as T;
 
@@ -127,8 +133,9 @@ class MemoryDocument<T> extends Document<T> {
   }
 
   /** Implements interface to update a document. */
-  static async _update<T>(query: QueryMap, mutation: MutationMap): Promise<T> {
-    const idValue = got(query, this.idKey, 'Query parameter "$PATH" is required') as string;
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  static async _update<T>(query: QueryMap, mutation: MutationMap, _context: Context, _previousAttributes: T): Promise<T> {
+    const idValue = got(query, this.idKey, QUERY_ERROR_TEMPLATE) as string;
 
     const componentTitle = this.getTitle();
     const item = got(this.collection, idValue, `${componentTitle} with ID "$PATH" is not found`) as T;
@@ -139,8 +146,9 @@ class MemoryDocument<T> extends Document<T> {
   }
 
   /** Implements interface to delete a document. */
-  static async _delete<T>(query: QueryMap): Promise<void> {
-    const idValue = got(query, this.idKey, 'Query parameter "$PATH" is required') as string;
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  static async _delete<T>(query: QueryMap, _context: Context, _previousAttributes: T): Promise<void> {
+    const idValue = got(query, this.idKey, QUERY_ERROR_TEMPLATE) as string;
 
     const componentTitle = this.getTitle();
     got(this.collection, idValue, `${componentTitle} with ID "$PATH" is not found`) as T;

package/src/Document/__tests__/MemoryDocument.test.ts

@@ -53,6 +53,22 @@ describe('MemoryDocument', () => {
     });
   });
 
+  describe('MemoryDocument._extendWithDeletedStamps', () => {
+    it('returns document body schema', () => {
+      const mutation = {
+        deletedAt: undefined,
+        deletedBy: undefined,
+        deletedByUserName: undefined,
+      };
+
+      Profile._extendWithDeletedStamps(context, mutation);
+
+      expect(mutation.deletedAt).toBeDefined();
+      expect(mutation.deletedBy).toEqual('SYSTEM');
+      expect(mutation.deletedByUserName).toBeNull();
+    });
+  });
+
   describe('MemoryDocument.create(context, query, mutation)', () => {
     it('creates a document from mutation', async () => {
       const profile = await Profile.create(context, {}, attributes);

package/src/Document/index.ts

@@ -1,4 +1,4 @@
-import Document, { type DefaultAttributes } from './Document';
+import Document from './Document';
 import MemoryDocument from './MemoryDocument';
 
 export {
@@ -6,6 +6,4 @@ export {
   MemoryDocument,
 };
 
-export type {
-  DefaultAttributes,
-};
+export type * from './Document';

package/src/Operation/Operation.ts

@@ -184,11 +184,11 @@ class Operation {
       errors.InvalidParametersError = {
         statusCode: 400,
         description: 'Invalid operation parameters, input syntax is correct,' +
-          ' but input values are not processible'
+          ' but input values are not processable'
       };
     }
 
-    errors.UnprocessibleConditionError = {
+    errors.UnprocessableConditionError = {
       statusCode: 422,
       description: 'Operation failed to process the request cause of expected' +
         ' exit condition'

package/src/Operation/errors/{UnprocessibleConditionError.ts → UnprocessableConditionError.ts}

@@ -1,9 +1,9 @@
 import CommonError from './CommonError';
 
 /**
- * Unprocessible Condition Error
+ * Unprocessable Condition Error
  *
- * `UnprocessibleConditionError` represents a **422 Unprocessable Entity** error that occurs
+ * `UnprocessableConditionError` represents a **422 Unprocessable Entity** error that occurs
  * when an operation encounters an expected exit condition that prevents it from processing
  * the request. This error indicates that the request is well-formed and valid, but the
  * operation cannot proceed due to business logic constraints or state conditions.
@@ -22,11 +22,11 @@ import CommonError from './CommonError';
  * The 422 status code indicates that the server understands the request but cannot process
  * it due to semantic errors or business logic constraints.
  */
-class UnprocessibleConditionError extends CommonError {
-  /** Creates an instance of unprocessible condition error. */
-  constructor(message: string = 'Unprocessible condition') {
-    super('UnprocessibleConditionError', message);
+class UnprocessableConditionError extends CommonError {
+  /** Creates an instance of unprocessable condition error. */
+  constructor(message: string = 'Unprocessable condition') {
+    super('UnprocessableConditionError', message);
   }
 }
 
-export default UnprocessibleConditionError;
+export default UnprocessableConditionError;

package/src/Operation/errors/__tests__/UnprocessableConditionError.test.ts

@@ -0,0 +1,20 @@
+import UnprocessableConditionError from '../UnprocessableConditionError';
+
+describe('UnprocessableConditionError', () => {
+  describe('UnprocessableConditionError.constructor(message)', () => {
+    it('creates an instance with default message when no message is provided', () => {
+      const err = new UnprocessableConditionError();
+
+      expect(err.code).toBe('UnprocessableConditionError');
+      expect(err.message).toBe('Unprocessable condition');
+    });
+
+    it('creates an instance with custom message when provided', () => {
+      const customMessage = 'Order is already canceled';
+      const err = new UnprocessableConditionError(customMessage);
+
+      expect(err.code).toBe('UnprocessableConditionError');
+      expect(err.message).toBe(customMessage);
+    });
+  });
+});

package/src/Operation/errors/index.ts

@@ -4,7 +4,7 @@ import AccessDeniedError from './AccessDeniedError';
 import DocumentExistsError from './DocumentExistsError';
 import DocumentNotFoundError from './DocumentNotFoundError';
 import InvalidParametersError from './InvalidParametersError';
-import UnprocessibleConditionError from './UnprocessibleConditionError';
+import UnprocessableConditionError from './UnprocessableConditionError';
 
 export {
   CommonError,
@@ -13,5 +13,5 @@ export {
   DocumentExistsError,
   DocumentNotFoundError,
   InvalidParametersError,
-  UnprocessibleConditionError,
+  UnprocessableConditionError,
 };

package/src/Operation/operations/Index.ts

@@ -1,5 +1,5 @@
 import Component from '../../Component';
-import { capitalize } from 'lodash';
+import { get, capitalize } from 'lodash';
 import Operation, { type Result } from '../Operation';
 import { type PropertiesSchemaSource } from '@kravc/schema';
 
@@ -9,7 +9,7 @@ const SORT_ORDER = {
 };
 
 const DEFAULT_LIMIT = 20;
-const DEFAULT_LIMIT_MAX = 999;
+const DEFAULT_LIMIT_MAX = 100;
 const DEFAULT_SORT_ORDER = SORT_ORDER.DESC;
 
 export type PageInfo = {
@@ -53,12 +53,12 @@ const Index = (
 
     /** Returns default value for a limit parameter. */
     static get defaultLimit() {
-      return DEFAULT_LIMIT;
+      return get(ComponentClass, 'indexDefaultLimit', DEFAULT_LIMIT);
     }
 
     /** Returns maximum number for a limit parameter. */
     static get limitMax() {
-      return DEFAULT_LIMIT_MAX;
+      return get(ComponentClass, 'indexLimitMax', DEFAULT_LIMIT_MAX);
     }
 
     /** Returns default value for a sort parameter. */
@@ -106,12 +106,12 @@ const Index = (
             },
             count: {
               type: 'integer',
-              example: 0,
+              example: 5,
               description: `Number of ${documentTitle}`,
             },
             limit: {
               type: 'integer',
-              example: 100,
+              example: get(ComponentClass, 'indexDefaultLimit', DEFAULT_LIMIT),
               description: `Limit number of ${documentTitle} to be returned`,
             },
             lastEvaluatedKey: {
@@ -127,7 +127,7 @@ const Index = (
       const {
         sort,
         limit,
-        index,
+        indexName,
         exclusiveStartKey,
         ...query
       } = parameters;
@@ -135,7 +135,7 @@ const Index = (
       const options = {
         sort,
         limit,
-        index,
+        indexName,
         exclusiveStartKey,
       };
 

package/src/Operation/operations/List.ts

@@ -39,13 +39,13 @@ const List = (
     async action(parameters: Record<string, unknown>) {
       const {
         sort,
-        index,
+        indexName,
         ...query
       } = parameters;
 
       const options = {
         sort,
-        index,
+        indexName,
       };
 
       const { componentActionMethod } = this.constructor as typeof Operation;

package/src/Operation/operations/__tests__/Create.test.ts

@@ -100,7 +100,7 @@ describe('Create(Document, actionMethod)', () => {
         const errorCodes = Object.keys(CreateProfile.errors);
         expect(errorCodes).toContain('InvalidInputError');
         expect(errorCodes).toContain('InvalidOutputError');
-        expect(errorCodes).toContain('UnprocessibleConditionError');
+        expect(errorCodes).toContain('UnprocessableConditionError');
         expect(errorCodes).toContain('DocumentExistsError');
       });
     });

package/src/Operation/operations/__tests__/Delete.test.ts

@@ -99,7 +99,7 @@ describe('Delete(Document, actionMethod)', () => {
       it('includes related errors', () => {
         const errorCodes = Object.keys(DeleteProfile.errors);
         expect(errorCodes).toContain('InvalidInputError');
-        expect(errorCodes).toContain('UnprocessibleConditionError');
+        expect(errorCodes).toContain('UnprocessableConditionError');
         expect(errorCodes).toContain('DocumentNotFoundError');
       });
     });

package/src/Operation/operations/__tests__/Index.test.ts

@@ -95,7 +95,7 @@ describe('Index(Document, actionMethod)', () => {
         const errorCodes = Object.keys(IndexProfiles.errors);
         expect(errorCodes).toContain('InvalidInputError');
         expect(errorCodes).toContain('InvalidOutputError');
-        expect(errorCodes).toContain('UnprocessibleConditionError');
+        expect(errorCodes).toContain('UnprocessableConditionError');
       });
     });
 
@@ -107,7 +107,7 @@ describe('Index(Document, actionMethod)', () => {
             example: 20,
             default: 20,
             minimum: 1,
-            maximum: 999,
+            maximum: 100,
             description: 'Limit number of profiles to be returned',
           },
           sort: {
@@ -146,12 +146,12 @@ describe('Index(Document, actionMethod)', () => {
               },
               count: {
                 type: 'integer',
-                example: 0,
+                example: 5,
                 description: 'Number of profiles',
               },
               limit: {
                 type: 'integer',
-                example: 100,
+                example: 20,
                 description: 'Limit number of profiles to be returned',
               },
               lastEvaluatedKey: {

package/src/Operation/operations/__tests__/List.test.ts

@@ -93,7 +93,7 @@ describe('List(Document, actionMethod)', () => {
       it('includes related errors', () => {
         const errorCodes = Object.keys(ListProfiles.errors);
         expect(errorCodes).toContain('InvalidOutputError');
-        expect(errorCodes).toContain('UnprocessibleConditionError');
+        expect(errorCodes).toContain('UnprocessableConditionError');
       });
     });
 

package/src/Operation/operations/__tests__/Read.test.ts

@@ -94,7 +94,7 @@ describe('Read(Document, actionMethod)', () => {
         const errorCodes = Object.keys(ReadProfile.errors);
         expect(errorCodes).toContain('InvalidInputError');
         expect(errorCodes).toContain('InvalidOutputError');
-        expect(errorCodes).toContain('UnprocessibleConditionError');
+        expect(errorCodes).toContain('UnprocessableConditionError');
         expect(errorCodes).toContain('DocumentNotFoundError');
       });
     });

package/src/Operation/operations/__tests__/Update.test.ts

@@ -100,7 +100,7 @@ describe('Update(Document, actionMethod)', () => {
         const errorCodes = Object.keys(UpdateProfile.errors);
         expect(errorCodes).toContain('InvalidInputError');
         expect(errorCodes).toContain('InvalidOutputError');
-        expect(errorCodes).toContain('UnprocessibleConditionError');
+        expect(errorCodes).toContain('UnprocessableConditionError');
         expect(errorCodes).toContain('DocumentNotFoundError');
       });
     });

package/src/Service/__tests__/Service.test.ts

@@ -178,12 +178,7 @@ describe('Service', () => {
 
       const body = JSON.parse(json!);
 
-      expect(body).toEqual({
-        info: {
-          title: '@kravc/dos',
-          version: '2.0.0-alpha.0',
-        },
-      });
+      expect(body.info.title).toEqual('@kravc/dos');
     });
 
     it('returns composer file for /Enums.yaml path', async () => {

package/src/Service/errors/OperationError.ts

@@ -2,7 +2,7 @@ import path from 'path';
 import Component from '../../Component';
 import { Context } from '../../Context';
 import { loadSync } from '@kravc/schema';
-import { OperationErrorAttibutes } from './OperationErrorAttributes';
+import { OperationErrorAttributes } from './OperationErrorAttributes';
 import logOperationError, { type OriginalError, type ErrorAttributes } from './logOperationError';
 
 const SCHEMA_PATH = path.resolve(__dirname) + '/OperationError.yaml';
@@ -28,7 +28,7 @@ const INTERNAL_ERROR_CODE = 500;
  * This class acts as the final error handler in the operation processing pipeline,
  * transforming any thrown error into a standardized, schema-validated response format.
  */
-class OperationError extends Component<OperationErrorAttibutes> {
+class OperationError extends Component<OperationErrorAttributes> {
   /** Returns schema of the operation error. */
   static get schema() {
     return operationErrorSchema;

package/src/Service/errors/OperationErrorAttributes.d.ts

@@ -1,4 +1,4 @@
-export type OperationErrorAttibutes = {
+export type OperationErrorAttributes = {
   error: {
     code: string;
     message: string;

package/src/Operation/errors/__tests__/UnprocessibleConditionError.test.ts

@@ -1,20 +0,0 @@
-import UnprocessibleConditionError from '../UnprocessibleConditionError';
-
-describe('UnprocessibleConditionError', () => {
-  describe('UnprocessibleConditionError.constructor(message)', () => {
-    it('creates an instance with default message when no message is provided', () => {
-      const err = new UnprocessibleConditionError();
-
-      expect(err.code).toBe('UnprocessibleConditionError');
-      expect(err.message).toBe('Unprocessible condition');
-    });
-
-    it('creates an instance with custom message when provided', () => {
-      const customMessage = 'Order is already cancelled';
-      const err = new UnprocessibleConditionError(customMessage);
-
-      expect(err.code).toBe('UnprocessibleConditionError');
-      expect(err.message).toBe(customMessage);
-    });
-  });
-});