api-smart-diff - npm Package Compare versions

Comparing version 1.0.0-alpha.2 to 1.0.0

package.json

 {
   "name": "api-smart-diff",
-  "version": "1.0.0-alpha.2",
-  "description": "Generate the diff between two API specifications (OpenAPI, AsyncAPI, JsonSchema)",
+  "version": "1.0.0",
+  "description": "Generate the diff between two API specifications (OpenAPI, AsyncAPI, GraphApi, JsonSchema)",
   "module": "dist/index.mjs",
   "main": "dist/index.cjs",
-  "browser": "dist/index.iife.js",
+  "browser": "dist/api-smart-diff.min.js",
   "typings": "dist/index.d.ts",
@@ -14,2 +14,3 @@ "files": [
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
@@ -37,2 +38,6 @@ "require": "./dist/index.cjs"
   ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/udamir/api-smart-diff"
+  },
   "author": "Damir Yusipov",
@@ -83,5 +88,5 @@ "license": "MIT",
   "dependencies": {
-    "allof-merge": "^0.6.1",
-    "json-crawl": "^0.4.2"
+    "allof-merge": "^0.6.4",
+    "json-crawl": "^0.5.2"
   }
 }

README.md

@@ -14,31 +14,6 @@ # api-smart-diff
 - [OpenApi 3.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md)
-  - [x] Rules
-  - [x] Transformations
-  - [x] Annotations
-  - [x] Unit Tests
-  - [x] E2E Tests
 - [AsyncApi 2.x](https://v2.asyncapi.com/docs/reference)
-  - [x] Rules
-  - [ ] Transformations
-  - [ ] Annotations
-  - [ ] Unit Tests
-  - [ ] E2E Tests
 - [JsonSchema](https://json-schema.org/draft/2020-12/json-schema-core.html)
-  - [x] Rules
-  - [x] Transformations
-  - [x] Annotations
-  - [x] Unit Tests
-  - [x] E2E Tests
-- [Swagger 2.0](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md)
-  - [ ] Rules
-  - [ ] Transformations
-  - [ ] Annotations
-  - [ ] Unit Tests
-  - [ ] E2E Tests
 - GraphQL via [GraphApi](https://github.com/udamir/graphapi)
-  - [x] Rules
-  - [x] Transformations
-  - [ ] Annotations
-  - [ ] Unit Tests
-  - [ ] E2E Tests
+- ~~[Swagger 2.0](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md)~~
 - ~~[AsyncApi 3.x](https://www.asyncapi.com/docs/specifications/)~~ (Roadmap)
@@ -58,3 +33,3 @@ - ~~gRPC~~ (Roadmap)
 - Typescript syntax support out of the box
-- No dependencies, can be used in nodejs or browser
+- Can be used in nodejs or browser
 
@@ -65,2 +40,6 @@ ## Installation
 ```
+or
+```SH
+yarn add api-smart-diff
+```
 
@@ -91,3 +70,2 @@ ## Usage
 
-
 ```
@@ -99,4 +77,3 @@
 ```html
-<script src="https://cdn.jsdelivr.net/npm/api-smart-diff@latest/browser/api-smart-diff.min.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/api-smart-diff@latest/browser/api-smart-diff.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/api-smart-diff@latest/dist/api-smart-diff.min.js"></script>
 ```
@@ -244,3 +221,3 @@
 
-Please run the unit tests before submitting your PR: `npm test`. Hopefully your PR includes additional unit tests to illustrate your change/modification!
+Please run the unit tests before submitting your PR: `yarn test`. Hopefully your PR includes additional unit tests to illustrate your change/modification!
 
@@ -247,0 +224,0 @@ ## License

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

585999

increased by1362.47%

Lines of code

1231

increased by136.28%

Number of low quality alerts

1

decreased by-50%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Number of lines in readme file

221

decreased by-9.43%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• - Removedjson-crawl@0.4.2(transitive)

• Updatedallof-merge@^0.6.4

• Updatedjson-crawl@^0.5.2