openapi3-ts - npm Package Compare versions

Comparing version 4.1.2 to 4.2.0

Changelog.md

 # Changelog: openapi3-ts
 
+## Version 4.2.0
+
+2023.12.20
+
+- Added [#126](https://github.com/metadevpro/openapi3-ts/pull/126) Adding contentEncoding and contentMediaType to 3.1 by @RobinTail
+- Updated dependencies
+
+
 ## Version 4.1.2
@@ -4,0 +12,0 @@

dist/index.js

@@ -1,2 +0,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=require("./oas30-14584a9c.js"),o=require("./oas31-ebde447c.js"),e=require("./server-3730ae43.js");require("yaml");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-zGY2VGOJ.js"),o=require("./oas31-2ULMvMLl.js"),e=require("./server-kRKy5879.js");require("yaml");exports.oas30=r.oas30;exports.oas31=o.oas31;exports.Server=e.Server;exports.ServerVariable=e.ServerVariable;
 //# sourceMappingURL=index.js.map

dist/model/openapi30.d.ts

@@ -214,3 +214,3 @@ import { ServerObject } from './oas-common';
     example?: any;
-    examples?: any[];
+    examples?: ExamplesObject;
     deprecated?: boolean;
@@ -217,0 +217,0 @@ type?: SchemaObjectType | SchemaObjectType[];

dist/model/openapi31.d.ts

@@ -31,2 +31,3 @@ import { ServerObject } from './oas-common';
     name: string;
+    identifier?: string;
     url?: string;
@@ -216,3 +217,3 @@ }
     example?: any;
-    examples?: any[];
+    examples?: ExamplesObject;
     deprecated?: boolean;
@@ -230,2 +231,3 @@ type?: SchemaObjectType | SchemaObjectType[];
     additionalProperties?: SchemaObject | ReferenceObject | boolean;
+    propertyNames?: SchemaObject | ReferenceObject;
     description?: string;
@@ -250,2 +252,4 @@ default?: any;
     prefixItems?: (SchemaObject | ReferenceObject)[];
+    contentMediaType?: string;
+    contentEncoding?: string;
 }
@@ -252,0 +256,0 @@ export declare function isSchemaObject(schema: SchemaObject | ReferenceObject): schema is SchemaObject;

dist/oas30.js

@@ -1,2 +0,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./oas30-14584a9c.js"),r=require("./server-3730ae43.js");require("yaml");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-zGY2VGOJ.js"),r=require("./server-kRKy5879.js");require("yaml");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-ebde447c.js"),r=require("./server-3730ae43.js");require("yaml");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-2ULMvMLl.js"),r=require("./server-kRKy5879.js");require("yaml");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.1.2",
+    "version": "4.2.0",
     "description": "TS Model & utils for OpenAPI 3.x specification.",
@@ -50,21 +50,21 @@ "main": "dist/index.js",
     "dependencies": {
-        "yaml": "^2.2.2"
+        "yaml": "^2.3.4"
     },
     "devDependencies": {
-        "@types/node": "^18.16.0",
-        "@typescript-eslint/eslint-plugin": "^5.59.1",
-        "@typescript-eslint/parser": "^5.59.1",
+        "@types/node": "^20.10.5",
+        "@typescript-eslint/eslint-plugin": "^6.15.0",
+        "@typescript-eslint/parser": "^6.15.0",
         "@vitest/coverage-c8": "^0.30.1",
-        "c8": "^7.13.0",
+        "c8": "^8.0.1",
         "coveralls": "^3.1.1",
-        "eslint": "^8.39.0",
-        "eslint-config-prettier": "^8.8.0",
-        "eslint-plugin-prettier": "^4.2.1",
-        "prettier": "^2.8.8",
-        "rimraf": "^5.0.0",
-        "typescript": "~5.0.4",
-        "vite": "^4.3.1",
-        "vitest": "^0.30.1",
-        "vitest-teamcity-reporter": "^0.1.12"
+        "eslint": "^8.56.0",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-plugin-prettier": "^5.1.0",
+        "prettier": "^3.1.1",
+        "rimraf": "^5.0.5",
+        "typescript": "~5.3.3",
+        "vite": "^5.0.10",
+        "vitest": "^0.34.6",
+        "vitest-teamcity-reporter": "^0.2.1"
     }
 }

src/model/openapi30.ts

@@ -279,3 +279,3 @@ /* eslint-disable @typescript-eslint/no-explicit-any */
     example?: any;
-    examples?: any[];
+    examples?: ExamplesObject;
     deprecated?: boolean;
@@ -282,0 +282,0 @@

src/model/openapi31.ts

@@ -39,2 +39,3 @@ /* eslint-disable @typescript-eslint/no-explicit-any */
     name: string;
+    identifier?: string;
     url?: string;
@@ -275,3 +276,3 @@ }
     example?: any;
-    examples?: any[];
+    examples?: ExamplesObject;
     deprecated?: boolean;
@@ -298,2 +299,3 @@
     additionalProperties?: SchemaObject | ReferenceObject | boolean;
+    propertyNames?: SchemaObject | ReferenceObject;
     description?: string;
@@ -321,2 +323,15 @@ default?: any;
     prefixItems?: (SchemaObject | ReferenceObject)[];
+    /** 
+     * @desc JSON Schema compliant Content-Type, optional when specified as a key of ContentObject
+     * @example image/png
+     */
+    contentMediaType?: string;
+    /**
+     * @desc Specifies the Content-Encoding for the schema, supports all encodings from RFC4648, and "quoted-printable" from RFC2045
+     * @override format
+     * @see https://datatracker.ietf.org/doc/html/rfc4648
+     * @see https://datatracker.ietf.org/doc/html/rfc2045#section-6.7
+     * @example base64
+     */
+    contentEncoding?: string;    
 }
@@ -323,0 +338,0 @@

test/package.json

@@ -8,11 +8,13 @@ {
     "test:mjs": "node index.mjs",
-    "test:ts": "ts-node --project fixture/tsconfig.node.json index.ts",
-    "test:ts-esm": "ts-node --esm --project fixture/tsconfig.node.json index.ts",
-    "test:ts-node16": "ts-node --project fixture/tsconfig.node16.json index.ts",
-    "test:ts-esm-node16": "ts-node --esm --project fixture/tsconfig.node16.json index.ts"
+    "test:ts": "tsx --tsconfig fixture/tsconfig.node.json index.cts",
+    "test:ts-esm": "tsx --tsconfig fixture/tsconfig.node.json index.mts",
+    "test:ts-node16": "tsx --tsconfig fixture/tsconfig.node16.json index.cts",
+    "test:ts-esm-node16": "tsx --tsconfig fixture/tsconfig.node16.json index.mts"
   },
   "dependencies": {
-    "openapi3-ts": "file:..",
-    "ts-node": "^10.9.1"
+    "openapi3-ts": "file:.."
+  },
+  "devDependencies": {
+    "tsx": "^4.6.2"
   }
 }

tsconfig.json

@@ -7,3 +7,3 @@ {
         "preserveConstEnums": true,
-        "module": "ESNext",
+        "module": "Node16",
         "moduleResolution": "Node16",
@@ -10,0 +10,0 @@ "noEmitHelpers": true,

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

250234

increased by1.04%

Number of package files

69

increased by1.47%

Lines of code

3433

increased by0.35%

Dependency changes

• Updatedyaml@^2.3.4