@kravc/dos 2.0.0-alpha.22 → 2.0.0-alpha.23

package/.claude/settings.local.json

@@ -16,7 +16,9 @@
       "Bash(node -e \"const ZSchema = require\\(''''/Users/ok/dev/dos/dos/node_modules/z-schema''''\\); console.log\\(Object.getOwnPropertyNames\\(ZSchema.prototype\\).join\\(''''\\\\n''''\\)\\)\")",
       "Bash(node:*)",
       "Bash(npx tsc@5.9.3 --noEmit)",
-      "Bash(npm test:*)"
+      "Bash(npm test:*)",
+      "Bash(npx jest:*)",
+      "Bash(npm run:*)"
     ]
   }
 }

package/.composer/documents/ExampleDocument.yaml

@@ -0,0 +1,9 @@
+name: ExampleDocument
+attributes:
+  - name: title
+    title: Title
+    description: Title of the document
+    required: true
+    type: string
+    isEnum: false
+    isArray: false

package/.composer/enums/ExampleEnum.yaml

@@ -0,0 +1,5 @@
+name: ExampleEnum
+values:
+  - value: ExampleValue
+    name: ''
+    description: ''

package/.composer/operations/ExampleDocument/ExampleOperation.yaml

@@ -0,0 +1,9 @@
+operationId: ExampleOperation
+baseAction: Read
+isPublic: true
+isSystem: false
+permissions: []
+summary: Example operation.
+description: Example operation demonstrating the composer operation format.
+query: {}
+mutation: {}

package/.composer/parameters/ExampleOperation.yaml

@@ -0,0 +1,9 @@
+operationId: ExampleOperation
+query:
+  - name: id
+    title: ID
+    description: ID of the example resource
+    required: true
+    type: string
+    isEnum: false
+    isArray: false

package/.composer/scenarios/ExampleScenario.yaml

@@ -0,0 +1,17 @@
+code: E1
+title: exampleScenario
+summary: Example scenario demonstrating basic operation flow
+parameters:
+  - name: id
+    value: EXAMPLE_1
+variableNames:
+  - id
+steps:
+  - summary: Operation is executed successfully
+    role: USER
+    operationId: ExampleOperation
+    parameters:
+      - name: id
+    result:
+      - has:
+          path: id

package/.composer/schemas/ExampleSchema.yaml

@@ -0,0 +1,9 @@
+name: ExampleSchema
+attributes:
+  - name: id
+    title: ID
+    description: Unique identifier
+    required: true
+    type: string
+    isEnum: false
+    isArray: false

package/dist/Service/useComposerMiddleware.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useComposerMiddleware.d.ts","sourceRoot":"","sources":["../../src/Service/useComposerMiddleware.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAc1C,8DAA8D;AAC9D,QAAA,MAAM,qBAAqB,GAAI,UAAU,OAAO,EAAE,SAAS,OAAO;;;;;;QAqCjE,CAAC;AAEF,eAAe,qBAAqB,CAAC"}
+{"version":3,"file":"useComposerMiddleware.d.ts","sourceRoot":"","sources":["../../src/Service/useComposerMiddleware.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AA6B1C,8DAA8D;AAC9D,QAAA,MAAM,qBAAqB,GAAI,UAAU,OAAO,EAAE,SAAS,OAAO;;;;;;QA0BjE,CAAC;AAEF,eAAe,qBAAqB,CAAC"}

package/dist/Service/useComposerMiddleware.js

@@ -1,35 +1,41 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = require("fs");
+const path_1 = require("path");
 const js_yaml_1 = require("js-yaml");
 const useOasMiddleware_1 = require("./useOasMiddleware");
 const ROOT_PATH = process.cwd();
-const COMPOSER_FILES = [
-    '/Enums.yaml',
-    '/Schemas.yaml',
-    '/Documents.yaml',
-    '/Scenarios.yaml',
-    '/Operations.yaml',
-    '/Parameters.yaml'
-];
+const COMPOSER_DIR_MAP = {
+    '/Enums.yaml': 'enums',
+    '/Schemas.yaml': 'schemas',
+    '/Documents.yaml': 'documents',
+    '/Scenarios.yaml': 'scenarios',
+    '/Operations.yaml': 'operations',
+    '/Parameters.yaml': 'parameters',
+};
+/** Reads all YAML files in a directory and returns their parsed contents as an array. */
+const readYamlDir = (dirPath) => (0, fs_1.readdirSync)(dirPath)
+    .filter(entry => entry.endsWith('.yaml') || entry.endsWith('.yml'))
+    .map(entry => (0, js_yaml_1.load)((0, fs_1.readFileSync)((0, path_1.join)(dirPath, entry), 'utf8')));
+/** Reads operations directory and returns operations grouped by document (subdirectory name). */
+const readOperationsDir = (dirPath) => (0, fs_1.readdirSync)(dirPath)
+    .filter(entry => (0, fs_1.statSync)((0, path_1.join)(dirPath, entry)).isDirectory())
+    .map(document => ({
+    document,
+    operations: readYamlDir((0, path_1.join)(dirPath, document)),
+}));
 /** Returns result if request is for service composer file. */
 const useComposerMiddleware = (_service, context) => {
     const { httpPath, httpMethod, isDevelopment } = context;
     const isGetRequest = httpMethod === 'get';
-    /** Returns specified composer source file. */
-    const readFileJson = (httpPath) => {
-        const fileName = httpPath.replace('/', '');
-        const composerSource = (0, js_yaml_1.load)((0, fs_1.readFileSync)(`${ROOT_PATH}/.composer/${fileName}`, 'utf8'));
-        return JSON.stringify(composerSource, null, 2);
-    };
-    const isComposerPath = COMPOSER_FILES.includes(httpPath);
-    const shouldReturnComposerSource = isDevelopment &&
-        isGetRequest &&
-        isComposerPath;
+    const composerDir = COMPOSER_DIR_MAP[httpPath];
+    const shouldReturnComposerSource = isDevelopment && isGetRequest && !!composerDir;
     if (!shouldReturnComposerSource) {
         return null;
     }
-    const bodyJson = readFileJson(httpPath);
+    const dirPath = (0, path_1.join)(ROOT_PATH, '.composer', composerDir);
+    const data = httpPath === '/Operations.yaml' ? readOperationsDir(dirPath) : readYamlDir(dirPath);
+    const bodyJson = JSON.stringify(data, null, 2);
     return {
         headers: {
             'Content-Type': useOasMiddleware_1.JSON_TYPE

package/dist/Service/useComposerMiddleware.js.map

@@ -1 +1 @@
-{"version":3,"file":"useComposerMiddleware.js","sourceRoot":"","sources":["../../src/Service/useComposerMiddleware.ts"],"names":[],"mappings":";;AAAA,2BAAkC;AAClC,qCAA+B;AAE/B,yDAA0D;AAE1D,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;AAEhC,MAAM,cAAc,GAAG;IACrB,aAAa;IACb,eAAe;IACf,iBAAiB;IACjB,iBAAiB;IACjB,kBAAkB;IAClB,kBAAkB;CACnB,CAAC;AAEF,8DAA8D;AAC9D,MAAM,qBAAqB,GAAG,CAAC,QAAiB,EAAE,OAAgB,EAAE,EAAE;IACpE,MAAM,EACJ,QAAQ,EACR,UAAU,EACV,aAAa,EACd,GAAG,OAAO,CAAC;IAEZ,MAAM,YAAY,GAAG,UAAU,KAAK,KAAK,CAAC;IAE1C,8CAA8C;IAC9C,MAAM,YAAY,GAAG,CAAC,QAAgB,EAAE,EAAE;QACxC,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAC3C,MAAM,cAAc,GAAG,IAAA,cAAI,EAAC,IAAA,iBAAY,EAAC,GAAG,SAAS,cAAc,QAAQ,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;QAExF,OAAO,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACjD,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAEzD,MAAM,0BAA0B,GAC9B,aAAa;QACb,YAAY;QACZ,cAAc,CAAC;IAEjB,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IAExC,OAAO;QACL,OAAO,EAAE;YACP,cAAc,EAAE,4BAAS;SAC1B;QACD,UAAU,EAAE,4BAAS;QACrB,IAAI,EAAE,QAAQ;KACf,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,qBAAqB,CAAC"}
+{"version":3,"file":"useComposerMiddleware.js","sourceRoot":"","sources":["../../src/Service/useComposerMiddleware.ts"],"names":[],"mappings":";;AAAA,2BAAyD;AACzD,+BAA4B;AAC5B,qCAA+B;AAE/B,yDAA0D;AAE1D,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;AAEhC,MAAM,gBAAgB,GAA2B;IAC/C,aAAa,EAAE,OAAO;IACtB,eAAe,EAAE,SAAS;IAC1B,iBAAiB,EAAE,WAAW;IAC9B,iBAAiB,EAAE,WAAW;IAC9B,kBAAkB,EAAE,YAAY;IAChC,kBAAkB,EAAE,YAAY;CACjC,CAAC;AAEF,yFAAyF;AACzF,MAAM,WAAW,GAAG,CAAC,OAAe,EAAa,EAAE,CACjD,IAAA,gBAAW,EAAC,OAAO,CAAC;KACjB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;KAClE,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,IAAA,cAAI,EAAC,IAAA,iBAAY,EAAC,IAAA,WAAI,EAAC,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;AAEpE,iGAAiG;AACjG,MAAM,iBAAiB,GAAG,CAAC,OAAe,EAAa,EAAE,CACvD,IAAA,gBAAW,EAAC,OAAO,CAAC;KACjB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,IAAA,aAAQ,EAAC,IAAA,WAAI,EAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;KAC7D,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAChB,QAAQ;IACR,UAAU,EAAE,WAAW,CAAC,IAAA,WAAI,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;CACjD,CAAC,CAAC,CAAC;AAER,8DAA8D;AAC9D,MAAM,qBAAqB,GAAG,CAAC,QAAiB,EAAE,OAAgB,EAAE,EAAE;IACpE,MAAM,EACJ,QAAQ,EACR,UAAU,EACV,aAAa,EACd,GAAG,OAAO,CAAC;IAEZ,MAAM,YAAY,GAAG,UAAU,KAAK,KAAK,CAAC;IAC1C,MAAM,WAAW,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAC/C,MAAM,0BAA0B,GAAG,aAAa,IAAI,YAAY,IAAI,CAAC,CAAC,WAAW,CAAC;IAElF,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,OAAO,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;IAC1D,MAAM,IAAI,GAAG,QAAQ,KAAK,kBAAkB,CAAC,CAAC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IACjG,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAE/C,OAAO;QACL,OAAO,EAAE;YACP,cAAc,EAAE,4BAAS;SAC1B;QACD,UAAU,EAAE,4BAAS;QACrB,IAAI,EAAE,QAAQ;KACf,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,qBAAqB,CAAC"}

package/jest.config.mjs

@@ -3,5 +3,9 @@ export default {
   preset: 'ts-jest',
   testMatch: ['<rootDir>/src/**/*.test.ts'],
   maxWorkers: 1,
-  collectCoverageFrom: ['<rootDir>/src/**/*.ts'],
+  collectCoverageFrom: [
+    '<rootDir>/src/**/*.ts',
+    '!<rootDir>/src/**/index.ts',
+    '!<rootDir>/src/**/*.d.ts',
+  ],
 };

package/package.json

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

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

@@ -192,6 +192,26 @@ describe('Service', () => {
       expect(statusCode).toEqual(200);
     });
 
+    it('returns operations grouped by document for /Operations.yaml path', async () => {
+      const request = {
+        path: '/Operations.yaml',
+        method: 'get'
+      } as HttpRequest;
+
+      const { statusCode, body } = await service.process(request);
+
+      expect(statusCode).toEqual(200);
+
+      const data = JSON.parse(body!);
+
+      expect(data).toEqual(expect.arrayContaining([
+        expect.objectContaining({
+          document: expect.any(String),
+          operations: expect.any(Array),
+        }),
+      ]));
+    });
+
     it('supports operations without parameters', async () => {
       const request = {
         path: '/Health',

package/src/Service/useComposerMiddleware.ts

@@ -1,18 +1,34 @@
-import { readFileSync } from 'fs';
+import { readFileSync, readdirSync, statSync } from 'fs';
+import { join } from 'path';
 import { load } from 'js-yaml';
 import type { Context } from '../Context';
 import { OK_STATUS, JSON_TYPE } from './useOasMiddleware';
 
 const ROOT_PATH = process.cwd();
 
-const COMPOSER_FILES = [
-  '/Enums.yaml',
-  '/Schemas.yaml',
-  '/Documents.yaml',
-  '/Scenarios.yaml',
-  '/Operations.yaml',
-  '/Parameters.yaml'
-];
+const COMPOSER_DIR_MAP: Record<string, string> = {
+  '/Enums.yaml': 'enums',
+  '/Schemas.yaml': 'schemas',
+  '/Documents.yaml': 'documents',
+  '/Scenarios.yaml': 'scenarios',
+  '/Operations.yaml': 'operations',
+  '/Parameters.yaml': 'parameters',
+};
+
+/** Reads all YAML files in a directory and returns their parsed contents as an array. */
+const readYamlDir = (dirPath: string): unknown[] =>
+  readdirSync(dirPath)
+    .filter(entry => entry.endsWith('.yaml') || entry.endsWith('.yml'))
+    .map(entry => load(readFileSync(join(dirPath, entry), 'utf8')));
+
+/** Reads operations directory and returns operations grouped by document (subdirectory name). */
+const readOperationsDir = (dirPath: string): unknown[] =>
+  readdirSync(dirPath)
+    .filter(entry => statSync(join(dirPath, entry)).isDirectory())
+    .map(document => ({
+      document,
+      operations: readYamlDir(join(dirPath, document)),
+    }));
 
 /** Returns result if request is for service composer file. */
 const useComposerMiddleware = (_service: unknown, context: Context) => {
@@ -23,27 +39,16 @@ const useComposerMiddleware = (_service: unknown, context: Context) => {
   } = context;
 
   const isGetRequest = httpMethod === 'get';
-
-  /** Returns specified composer source file. */
-  const readFileJson = (httpPath: string) => {
-    const fileName = httpPath.replace('/', '');
-    const composerSource = load(readFileSync(`${ROOT_PATH}/.composer/${fileName}`, 'utf8'));
-
-    return JSON.stringify(composerSource, null, 2);
-  };
-
-  const isComposerPath = COMPOSER_FILES.includes(httpPath);
-
-  const shouldReturnComposerSource =
-    isDevelopment &&
-    isGetRequest &&
-    isComposerPath;
+  const composerDir = COMPOSER_DIR_MAP[httpPath];
+  const shouldReturnComposerSource = isDevelopment && isGetRequest && !!composerDir;
 
   if (!shouldReturnComposerSource) {
     return null;
   }
 
-  const bodyJson = readFileJson(httpPath);
+  const dirPath = join(ROOT_PATH, '.composer', composerDir);
+  const data = httpPath === '/Operations.yaml' ? readOperationsDir(dirPath) : readYamlDir(dirPath);
+  const bodyJson = JSON.stringify(data, null, 2);
 
   return {
     headers: {

package/.composer/Documents.yaml

@@ -1 +0,0 @@
-[]

package/.composer/Enums.yaml

@@ -1 +0,0 @@
-[]

package/.composer/Operations.yaml

@@ -1 +0,0 @@
-[]

package/.composer/Parameters.yaml

@@ -1 +0,0 @@
-[]

package/.composer/Scenarios.yaml

@@ -1 +0,0 @@
-[]

package/.composer/Schemas.yaml

@@ -1 +0,0 @@
-[]