openapi3-ts - npm Package Compare versions

Comparing version 3.1.2 to 3.2.0

Changelog.md

 # Changelog: openapi3-ts
 
+## Version 3.2.0
 
+- PR [#94](https://github.com/metadevpro/openapi3-ts/pull/94) Export type `SchemaObjectType`.
+- PR [#95](https://github.com/metadevpro/openapi3-ts/pull/95) Export type `SchemaObjectFormat`. Both contributed by @beautyfree
+
 ## Version 3.1.2
@@ -5,0 +9,0 @@

dist/cjs/model/OpenApi.d.ts

@@ -216,3 +216,4 @@ import { ISpecificationExtension } from './SpecificationExtension.js';
 export declare function isReferenceObject(obj: any): obj is ReferenceObject;
-type SchemaObjectType = 'integer' | 'number' | 'string' | 'boolean' | 'object' | 'null' | 'array';
+export type SchemaObjectType = 'integer' | 'number' | 'string' | 'boolean' | 'object' | 'null' | 'array';
+export type SchemaObjectFormat = 'int32' | 'int64' | 'float' | 'double' | 'byte' | 'binary' | 'date' | 'date-time' | 'password' | string;
 export interface SchemaObject extends ISpecificationExtension {
@@ -229,3 +230,3 @@ nullable?: boolean;
     type?: SchemaObjectType | SchemaObjectType[];
-    format?: 'int32' | 'int64' | 'float' | 'double' | 'byte' | 'binary' | 'date' | 'date-time' | 'password' | string;
+    format?: SchemaObjectFormat;
     allOf?: (SchemaObject | ReferenceObject)[];
@@ -305,2 +306,1 @@ oneOf?: (SchemaObject | ReferenceObject)[];
 }
-export {};

dist/mjs/model/OpenApi.d.ts

@@ -216,3 +216,4 @@ import { ISpecificationExtension } from './SpecificationExtension.js';
 export declare function isReferenceObject(obj: any): obj is ReferenceObject;
-type SchemaObjectType = 'integer' | 'number' | 'string' | 'boolean' | 'object' | 'null' | 'array';
+export type SchemaObjectType = 'integer' | 'number' | 'string' | 'boolean' | 'object' | 'null' | 'array';
+export type SchemaObjectFormat = 'int32' | 'int64' | 'float' | 'double' | 'byte' | 'binary' | 'date' | 'date-time' | 'password' | string;
 export interface SchemaObject extends ISpecificationExtension {
@@ -229,3 +230,3 @@ nullable?: boolean;
     type?: SchemaObjectType | SchemaObjectType[];
-    format?: 'int32' | 'int64' | 'float' | 'double' | 'byte' | 'binary' | 'date' | 'date-time' | 'password' | string;
+    format?: SchemaObjectFormat;
     allOf?: (SchemaObject | ReferenceObject)[];
@@ -305,2 +306,1 @@ oneOf?: (SchemaObject | ReferenceObject)[];
 }
-export {};

package.json

 {
     "name": "openapi3-ts",
-    "version": "3.1.2",
+    "version": "3.2.0",
     "description": "TS Model & utils for OpenAPI 3.x specification.",
@@ -33,20 +33,20 @@ "main": "dist/cjs/index.js",
     "dependencies": {
-        "yaml": "^2.1.3"
+        "yaml": "^2.2.1"
     },
     "devDependencies": {
-        "@types/node": "^18.11.9",
-        "@typescript-eslint/eslint-plugin": "^5.43.0",
-        "@typescript-eslint/parser": "^5.43.0",
-        "@vitest/coverage-c8": "^0.25.2",
-        "c8": "^7.12.0",
+        "@types/node": "^18.14.0",
+        "@typescript-eslint/eslint-plugin": "^5.53.0",
+        "@typescript-eslint/parser": "^5.53.0",
+        "@vitest/coverage-c8": "^0.28.5",
+        "c8": "^7.13.0",
         "coveralls": "^3.1.1",
-        "eslint": "^8.28.0",
-        "eslint-config-prettier": "^8.5.0",
+        "eslint": "^8.34.0",
+        "eslint-config-prettier": "^8.6.0",
         "eslint-plugin-prettier": "^4.2.1",
-        "prettier": "^2.7.1",
-        "rimraf": "^3.0.2",
-        "typescript": "~4.9.3",
-        "vitest": "^0.25.2",
+        "prettier": "^2.8.4",
+        "rimraf": "^4.1.2",
+        "typescript": "~4.9.5",
+        "vitest": "^0.28.5",
         "vitest-teamcity-reporter": "^0.1.10"
     }
 }

src/model/OpenApi.ts

@@ -271,4 +271,15 @@ /* eslint-disable @typescript-eslint/no-explicit-any */
 
-type SchemaObjectType = 'integer' | 'number' | 'string' | 'boolean' | 'object' | 'null' | 'array';
+export type SchemaObjectType = 'integer' | 'number' | 'string' | 'boolean' | 'object' | 'null' | 'array';
 
+export type SchemaObjectFormat = 'int32'
+    | 'int64'
+    | 'float'
+    | 'double'
+    | 'byte'
+    | 'binary'
+    | 'date'
+    | 'date-time'
+    | 'password'
+    | string
+
 export interface SchemaObject extends ISpecificationExtension {
@@ -286,13 +297,3 @@ nullable?: boolean;
     type?: SchemaObjectType | SchemaObjectType[];
-    format?:
-        | 'int32'
-        | 'int64'
-        | 'float'
-        | 'double'
-        | 'byte'
-        | 'binary'
-        | 'date'
-        | 'date-time'
-        | 'password'
-        | string;
+    format?: SchemaObjectFormat;
     allOf?: (SchemaObject | ReferenceObject)[];
@@ -299,0 +300,0 @@ oneOf?: (SchemaObject | ReferenceObject)[];

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

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

Improved metrics

Total package byte prevSize

93495

increased by0.38%

Dependency changes

• Updatedyaml@^2.2.1