@kravc/dos 2.0.0-alpha.2 → 2.0.0-alpha.20

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;
 
@@ -114,8 +119,9 @@ class MemoryDocument<T> extends Document<T> {
   }
 
   /** Implements interface to save a document. */
-  static async _create<T>(attributes: T): Promise<void> {
-    const idValue = got(attributes, this.idKey, 'Attribute "$PATH" is required') as string;
+  // 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/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'
@@ -331,7 +331,7 @@ class Operation {
   }
 
   /** Executes component action. */
-  async action(parameters: Record<string, unknown>) {
+  async action(parameters: Record<string, unknown>): Promise<{ data?: Result }> {
     const { Component } = this.constructor as typeof Operation;
 
     if (!Component) {
@@ -343,14 +343,11 @@ class Operation {
 
     const data = await componentActionMethod(this.context, query, mutation as MutationMap);
 
-    return { data } as { data?: Result };
+    return { data };
   }
 
   /** Post-processes operation result after action. */
-  async after(
-    _parameters: Record<string, unknown>,
-    result?: Record<string, unknown>
-  ): Promise<Result | void> {
+  async after(_parameters: Record<string, unknown>, result?: unknown): Promise<unknown | void> {
     return result;
   }
 
@@ -367,7 +364,7 @@ class Operation {
   /** Executes operation for the request input. */
   async exec(input: Record<string, unknown>): Promise<OperationResponse> {
     let parameters = cloneDeep(input);
-    let result;
+    let result: Result;
 
     const beforeResult = await this.before(parameters);
 
@@ -383,7 +380,7 @@ class Operation {
       ? (
           result.data
             ? { ...result, data: afterResult }
-            : afterResult
+            : afterResult as Result
         )
       : result;
 

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

@@ -35,17 +35,29 @@ const List = (
       return componentAction;
     }
 
+    /** Returns schema source for the operation output with pagination. */
+    static get output() {
+      return {
+        data: {
+          items: {
+            $ref: ComponentClass.schema!.id
+          },
+          required: true,
+        },
+      };
+    }
+
     /** Executes components list action. */
     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/Operation/security/userAuthorization.ts

@@ -2,8 +2,10 @@ import Operation from '../Operation';
 import JwtAuthorization, { type Permissions } from './JwtAuthorization';
 
 type Props = {
+  name?: string;
   issuer: string;
   publicKey: string;
+  description?: string;
   permissions?: Permissions;
 }
 

package/src/Service/Service.ts

@@ -34,7 +34,6 @@ const createDefaultContext = (
 
 type Module = {
   id: string;
-  get isComponent(): boolean;
 };
 
 type Options = {
@@ -45,6 +44,17 @@ type Options = {
   skipOperations?: string[];
 };
 
+/** Returns true if TargetClass is a constructor whose prototype extends BaseClass. */
+function isExtendedFrom(
+  TargetClass: unknown,
+  BaseClass: typeof Operation | typeof Component
+): boolean {
+  return (
+    typeof TargetClass === 'function' &&
+    (TargetClass as abstract new (...args: unknown[]) => unknown).prototype instanceof BaseClass
+  );
+}
+
 /** Service */
 class Service {
   private _url: string;
@@ -71,11 +81,14 @@ class Service {
       skipOperations = DEFAULT_SKIP_OPERATIONS,
     } = options;
 
-    let components = modules
-      .filter(ModuleClass => ModuleClass.isComponent) as (typeof Component)[];
+    const nonSchemas = modules
+      .filter(m => !(m instanceof Schema));
+
+    let components = nonSchemas
+      .filter(m => isExtendedFrom(m, Component)) as (typeof Component)[];
 
-    const operations = modules
-      .filter(ModuleClass => !ModuleClass.isComponent)
+    const operations = nonSchemas
+      .filter(m => isExtendedFrom(m, Operation))
       .filter(({ id: operationId }) => !skipOperations.includes(operationId)) as (typeof Operation)[];
 
     const referencedComponents = compact(operations.map(({ Component }) => Component));

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.2',
-        },
-      });
+      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/Service/test/execute.ts

@@ -10,7 +10,7 @@ type Parameters = {
   [index: string]: unknown;
 }
 
-type SuccessResult = { data: Record<string, unknown>; };
+type SuccessResult = { data: Record<string, unknown>[] | Record<string, unknown>; };
 type ErrorResult = { error: ErrorAttributes; };
 type Result = SuccessResult | ErrorResult;
 

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);
-    });
-  });
-});