openapi3-ts - npm Package Compare versions

Comparing version 4.3.3 to 4.4.0

Changelog.md

 # Changelog: openapi3-ts
 
+## Version 4.4.0
+
+2024.08.27
+
+- Updated libs
+- Updated lo latest eslint (migrated config file)
+- Updated vite config to mts
+- Added basic documentation. Fix [#75](https://github.com/metadevpro/openapi3-ts/pull/75). PR[#139](https://github.com/metadevpro/openapi3-ts/pull/139)
+- Feat: `getSpecAsYaml` accepts the same options as `yaml.stringify`. Fix [#143](https://github.com/metadevpro/openapi3-ts/issues/143). PR[#144](https://github.com/metadevpro/openapi3-ts/pull/144) by @urugator
+
 ## Version 4.3.3
@@ -4,0 +14,0 @@

dist/dsl/openapi-builder30.d.ts

@@ -0,1 +1,2 @@
+import * as yaml from 'yaml';
 import * as oa from '../model/openapi30';
@@ -8,3 +9,3 @@ export declare class OpenApiBuilder {
     getSpecAsJson(replacer?: (key: string, value: unknown) => unknown, space?: string | number): string;
-    getSpecAsYaml(): string;
+    getSpecAsYaml(replacer?: Parameters<typeof yaml.stringify>[1], options?: Parameters<typeof yaml.stringify>[2]): string;
     private static isValidOpenApiVersion;
@@ -11,0 +12,0 @@ addOpenApiVersion(openApiVersion: string): OpenApiBuilder;

dist/dsl/openapi-builder31.d.ts

@@ -0,1 +1,2 @@
+import * as yaml from 'yaml';
 import * as oa from '../model/openapi31';
@@ -8,3 +9,3 @@ export declare class OpenApiBuilder {
     getSpecAsJson(replacer?: (key: string, value: unknown) => unknown, space?: string | number): string;
-    getSpecAsYaml(): string;
+    getSpecAsYaml(replacer?: Parameters<typeof yaml.stringify>[1], options?: Parameters<typeof yaml.stringify>[2]): string;
     private static isValidOpenApiVersion;
@@ -11,0 +12,0 @@ addOpenApiVersion(openApiVersion: string): OpenApiBuilder;

dist/index.js

@@ -1,2 +0,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=require("./oas30-CAmzubQd.js"),o=require("./oas31-Dtl9zIuV.js"),e=require("./server-DVBno7Ee.js");exports.oas30=r.oas30;exports.oas31=o.oas31;exports.Server=e.Server;exports.ServerVariable=e.ServerVariable;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=require("./oas30-E9r1WxRR.js"),o=require("./oas31-Bx381qKf.js"),e=require("./server-DVBno7Ee.js");exports.oas30=r.oas30;exports.oas31=o.oas31;exports.Server=e.Server;exports.ServerVariable=e.ServerVariable;
 //# sourceMappingURL=index.js.map

dist/oas30.js

@@ -1,2 +0,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./oas30-CAmzubQd.js"),r=require("./server-DVBno7Ee.js");exports.OpenApiBuilder=e.OpenApiBuilder;exports.getPath=e.getPath;exports.isReferenceObject=e.isReferenceObject;exports.isSchemaObject=e.isSchemaObject;exports.Server=r.Server;exports.ServerVariable=r.ServerVariable;exports.addExtension=r.addExtension;exports.getExtension=r.getExtension;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./oas30-E9r1WxRR.js"),r=require("./server-DVBno7Ee.js");exports.OpenApiBuilder=e.OpenApiBuilder;exports.getPath=e.getPath;exports.isReferenceObject=e.isReferenceObject;exports.isSchemaObject=e.isSchemaObject;exports.Server=r.Server;exports.ServerVariable=r.ServerVariable;exports.addExtension=r.addExtension;exports.getExtension=r.getExtension;
 //# sourceMappingURL=oas30.js.map

dist/oas31.js

@@ -1,2 +0,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./oas31-Dtl9zIuV.js"),r=require("./server-DVBno7Ee.js");exports.OpenApiBuilder=e.OpenApiBuilder;exports.getPath=e.getPath;exports.isReferenceObject=e.isReferenceObject;exports.isSchemaObject=e.isSchemaObject;exports.Server=r.Server;exports.ServerVariable=r.ServerVariable;exports.addExtension=r.addExtension;exports.getExtension=r.getExtension;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./oas31-Bx381qKf.js"),r=require("./server-DVBno7Ee.js");exports.OpenApiBuilder=e.OpenApiBuilder;exports.getPath=e.getPath;exports.isReferenceObject=e.isReferenceObject;exports.isSchemaObject=e.isSchemaObject;exports.Server=r.Server;exports.ServerVariable=r.ServerVariable;exports.addExtension=r.addExtension;exports.getExtension=r.getExtension;
 //# sourceMappingURL=oas31.js.map

package.json

 {
     "name": "openapi3-ts",
-    "version": "4.3.3",
+    "version": "4.4.0",
     "description": "TS Model & utils for OpenAPI 3.x specification.",
@@ -51,19 +51,21 @@ "main": "dist/index.js",
     "dependencies": {
-        "yaml": "^2.4.5"
+        "yaml": "^2.5.0"
     },
     "devDependencies": {
-        "@types/node": "^20.14.2",
-        "@typescript-eslint/eslint-plugin": "^7.12.0",
-        "@typescript-eslint/parser": "^7.12.0",
-        "@vitest/coverage-v8": "^1.6.0",
+        "@eslint/eslintrc": "^3.1.0",
+        "@eslint/js": "^9.9.1",
+        "@types/node": "^22.5.0",
+        "@typescript-eslint/eslint-plugin": "^8.3.0",
+        "@typescript-eslint/parser": "^8.3.0",
+        "@vitest/coverage-v8": "^2.0.5",
         "coveralls": "^3.1.1",
-        "eslint": "^8.56.0",
+        "eslint": "^9.9.1",
         "eslint-config-prettier": "^9.1.0",
-        "eslint-plugin-prettier": "^5.1.3",
-        "prettier": "^3.3.1",
-        "rimraf": "^5.0.7",
-        "typescript": "~5.4.5",
-        "vite": "^5.2.13",
-        "vitest": "^1.6.0",
-        "vitest-teamcity-reporter": "^0.3.0"
+        "eslint-plugin-prettier": "^5.2.1",
+        "prettier": "^3.3.3",
+        "rimraf": "^6.0.1",
+        "typescript": "~5.5.4",
+        "vite": "^5.4.2",
+        "vitest": "^2.0.5",
+        "vitest-teamcity-reporter": "^0.3.1"
     },
@@ -70,0 +72,0 @@ "files": [

README.md

@@ -54,5 +54,6 @@ # OpenApi3-TS
 
-## Versions and Changelog
+## Documentation, Versions, and Changelog
 
-See [changelog](Changelog.md).
+* [Documentation](docs/index.md).
+* See [changelog](Changelog.md) for version and changes.
 
@@ -71,2 +72,2 @@ ## References
 
-(c) 2017-2023. [Pedro J. Molina](http://pjmolina.com) at Metadev S.L. [https://metadev.pro](https://metadev.pro) & contributors.
+(c) 2017-2024. [Pedro J. Molina](http://pjmolina.com) at Metadev S.L. [https://metadev.pro](https://metadev.pro) & contributors.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

170528

increased by1.85%

Lines of code

1137

increased by0.18%

Number of lines in readme file

72

increased by1.41%

Worsened metrics

Dev dependency count

16

increased by14.29%

Dependency changes

• Updatedyaml@^2.5.0