@navios/openapi 0.9.1 → 1.0.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/dist/legacy-compat/__type-tests__/tsconfig.tsbuildinfo +1 -1
  3. package/dist/src/services/endpoint-scanner.service.d.mts +2 -2
  4. package/dist/src/services/endpoint-scanner.service.d.mts.map +1 -1
  5. package/dist/src/services/path-builder.service.d.mts +13 -1
  6. package/dist/src/services/path-builder.service.d.mts.map +1 -1
  7. package/dist/tsconfig.lib.tsbuildinfo +1 -1
  8. package/dist/tsconfig.spec.tsbuildinfo +1 -1
  9. package/dist/tsconfig.tsbuildinfo +1 -1
  10. package/lib/{index-BYd1gzJQ.d.cts → index-COmVnnSM.d.mts} +17 -5
  11. package/lib/{index-BYd1gzJQ.d.cts.map → index-COmVnnSM.d.mts.map} +1 -1
  12. package/lib/{index-KzCwlPFD.d.mts → index-Dz-4huer.d.cts} +17 -5
  13. package/lib/{index-KzCwlPFD.d.mts.map → index-Dz-4huer.d.cts.map} +1 -1
  14. package/lib/index.cjs +1 -1
  15. package/lib/index.d.cts +1 -1
  16. package/lib/index.d.mts +1 -1
  17. package/lib/index.mjs +1 -1
  18. package/lib/legacy-compat/index.cjs +1 -1
  19. package/lib/legacy-compat/index.d.cts +1 -1
  20. package/lib/legacy-compat/index.d.mts +7 -7
  21. package/lib/legacy-compat/index.mjs +1 -1
  22. package/lib/{services-kEHEZqLZ.cjs → services-B16xN1Kh.cjs} +44 -12
  23. package/lib/services-B16xN1Kh.cjs.map +1 -0
  24. package/lib/{services-MFCyRMd8.mjs → services-B7UR1D1X.mjs} +45 -13
  25. package/lib/services-B7UR1D1X.mjs.map +1 -0
  26. package/package.json +4 -4
  27. package/src/services/endpoint-scanner.service.mts +14 -8
  28. package/src/services/path-builder.service.mts +85 -27
  29. package/lib/services-MFCyRMd8.mjs.map +0 -1
  30. package/lib/services-kEHEZqLZ.cjs.map +0 -1
@@ -1,5 +1,5 @@
1
+ import type { BaseEndpointOptions, EndpointOptions } from '@navios/builder';
1
2
  import type { ControllerMetadata, HandlerMetadata, ModuleMetadata } from '@navios/core';
2
- import type { BaseEndpointConfig } from '@navios/builder';
3
3
  import type { OpenApiEndpointMetadata } from '../metadata/openapi.metadata.mjs';
4
4
  /**
5
5
  * Represents a discovered endpoint with all its metadata
@@ -14,7 +14,7 @@ export interface DiscoveredEndpoint {
14
14
  /** Handler (endpoint) metadata */
15
15
  handler: HandlerMetadata<any>;
16
16
  /** Endpoint configuration from @navios/builder */
17
- config: BaseEndpointConfig;
17
+ config: EndpointOptions | BaseEndpointOptions;
18
18
  /** Extracted OpenAPI metadata */
19
19
  openApiMetadata: OpenApiEndpointMetadata;
20
20
  }
@@ -1 +1 @@
1
- {"version":3,"file":"endpoint-scanner.service.d.mts","sourceRoot":"","sources":["../../../src/services/endpoint-scanner.service.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,eAAe,EACf,cAAc,EACf,MAAM,cAAc,CAAA;AACrB,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAIzD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAA;AAI/E;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,sBAAsB;IACtB,MAAM,EAAE,cAAc,CAAA;IACtB,uBAAuB;IACvB,eAAe,EAAE,GAAG,CAAA;IACpB,0BAA0B;IAC1B,UAAU,EAAE,kBAAkB,CAAA;IAC9B,kCAAkC;IAClC,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,CAAA;IAC7B,kDAAkD;IAClD,MAAM,EAAE,kBAAkB,CAAA;IAC1B,iCAAiC;IACjC,eAAe,EAAE,uBAAuB,CAAA;CACzC;AAED;;;;;GAKG;AACH,qBACa,sBAAsB;IACjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAErB;IAEF,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmC;IAErE;;;;;OAKG;IACH,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,kBAAkB,EAAE;IAyBhE;;OAEG;IACH,OAAO,CAAC,cAAc;CAsCvB"}
1
+ {"version":3,"file":"endpoint-scanner.service.d.mts","sourceRoot":"","sources":["../../../src/services/endpoint-scanner.service.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAC3E,OAAO,KAAK,EACV,kBAAkB,EAClB,eAAe,EACf,cAAc,EACf,MAAM,cAAc,CAAA;AASrB,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAA;AAI/E;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,sBAAsB;IACtB,MAAM,EAAE,cAAc,CAAA;IACtB,uBAAuB;IACvB,eAAe,EAAE,GAAG,CAAA;IACpB,0BAA0B;IAC1B,UAAU,EAAE,kBAAkB,CAAA;IAC9B,kCAAkC;IAClC,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,CAAA;IAC7B,kDAAkD;IAClD,MAAM,EAAE,eAAe,GAAG,mBAAmB,CAAA;IAC7C,iCAAiC;IACjC,eAAe,EAAE,uBAAuB,CAAA;CACzC;AAED;;;;;GAKG;AACH,qBACa,sBAAsB;IACjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAErB;IAEF,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmC;IAErE;;;;;OAKG;IACH,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,kBAAkB,EAAE;IA4BhE;;OAEG;IACH,OAAO,CAAC,cAAc;CAoCvB"}
@@ -35,7 +35,7 @@ export declare class PathBuilderService {
35
35
  /**
36
36
  * Gets the endpoint type based on the adapter token
37
37
  */
38
- getEndpointType(handler: HandlerMetadata<any>): 'endpoint' | 'multipart' | 'stream';
38
+ getEndpointType(handler: HandlerMetadata<any>): 'endpoint' | 'multipart' | 'stream' | 'unknown';
39
39
  /**
40
40
  * Builds OpenAPI parameters from endpoint config
41
41
  */
@@ -56,6 +56,13 @@ export declare class PathBuilderService {
56
56
  * Builds responses based on endpoint type
57
57
  */
58
58
  private buildResponses;
59
+ /**
60
+ * Builds error responses from errorSchema
61
+ *
62
+ * @param errorSchema - Optional record mapping status codes to Zod schemas
63
+ * @returns ResponsesObject with error responses, or empty object if no errorSchema
64
+ */
65
+ private buildErrorResponses;
59
66
  /**
60
67
  * Builds responses for JSON endpoints
61
68
  */
@@ -64,6 +71,11 @@ export declare class PathBuilderService {
64
71
  * Builds responses for stream endpoints
65
72
  */
66
73
  private buildStreamResponses;
74
+ /**
75
+ * Builds responses for unknown endpoint types.
76
+ * Unknown types have no success response but can have error responses.
77
+ */
78
+ private buildUnknownResponses;
67
79
  /**
68
80
  * Gets content object for different stream types
69
81
  */
@@ -1 +1 @@
1
- {"version":3,"file":"path-builder.service.d.mts","sourceRoot":"","sources":["../../../src/services/path-builder.service.mts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AACnD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAUxC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AAOxE,KAAK,cAAc,GAAG,KAAK,CAAC,cAAc,CAAA;AAK1C;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,cAAc,CAAA;CACzB;AAED;;;;;GAKG;AACH,qBACa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiC;IAEjE;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,EAAE,kBAAkB,GAAG,cAAc;IAgCnD;;OAEG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAIrC;;OAEG;IACH,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE;IAK3C;;OAEG;IACH,eAAe,CACb,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,GAC5B,UAAU,GAAG,WAAW,GAAG,QAAQ;IAUtC;;OAEG;IACH,OAAO,CAAC,eAAe;IAoCvB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAiBxB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAmB5B;;OAEG;IACH,OAAO,CAAC,yBAAyB;IAmCjC;;OAEG;IACH,OAAO,CAAC,cAAc;IActB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA4B1B;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAmB5B;;OAEG;IACH,OAAO,CAAC,gBAAgB;CAyCzB"}
1
+ {"version":3,"file":"path-builder.service.d.mts","sourceRoot":"","sources":["../../../src/services/path-builder.service.mts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AACnD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAUxC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AAOxE,KAAK,cAAc,GAAG,KAAK,CAAC,cAAc,CAAA;AAK1C;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,cAAc,CAAA;CACzB;AAED;;;;;GAKG;AACH,qBACa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiC;IAEjE;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,EAAE,kBAAkB,GAAG,cAAc;IAgCnD;;OAEG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAIrC;;OAEG;IACH,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE;IAK3C;;OAEG;IACH,eAAe,CACb,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,GAC5B,UAAU,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS;IAalD;;OAEG;IACH,OAAO,CAAC,eAAe;IAoCvB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAiBxB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAmB5B;;OAEG;IACH,OAAO,CAAC,yBAAyB;IAoCjC;;OAEG;IACH,OAAO,CAAC,cAAc;IAiBtB;;;;;OAKG;IACH,OAAO,CAAC,mBAAmB;IAwB3B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA8B1B;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAuB5B;;;OAGG;IACH,OAAO,CAAC,qBAAqB;IAO7B;;OAEG;IACH,OAAO,CAAC,gBAAgB;CAyCzB"}