@fabernovel/heart-observatory - npm Package Compare versions

Comparing version 1.2.1 to 3.0.1

CHANGELOG.md

@@ -1,41 +0,31 @@
-## [1.2.1] - 2019-07-15
-### Changed
-- Heart wiki url from the README now properly redirect to the repository used before _Heart_ version 3
+# Change Log - @fabernovel/heart-observatory
 
-## [1.2.0] - 2019-06-28
-### Added
-- The module configuration has been extended to be closer to what the [Observatory API](https://github.com/mozilla/http-observatory/blob/master/httpobs/docs/api.md) offers
+This log was last generated on Fri, 19 Jul 2019 09:43:15 GMT and should not be manually modified.
 
-### Changed
-- Update README
+## 3.0.1
+Fri, 19 Jul 2019 09:43:15 GMT
 
-## [1.1.0] - 2019-06-14
-### Added
-- Analysis report now provide the normalized note
+### Patches
 
-## [1.0.3] - 2019-06-05
-### Added
-- Analysis report now provide the analysis date
+- Fix an issue where the binary was not packaged when published to NPM
 
-## [1.0.2] - 2019-06-03
-### Removed
-- config.json has been removed, because it could leads to some build errors
+## 3.0.0
+Fri, 19 Jul 2019 08:17:11 GMT
 
-## [1.0.1] - 2019-04-18
-### Added
-- NPM publish as GitLab CD
-- `@fabernovel/heart-server`is now a peerDependency
-- EditorConfig configuration file
+### Breaking changes
 
-### Changed
-- Upgrade `@fabernovel/heart-core`to latest version (the one that embed module loading code)
-- Updated code according to the upgrade
-- Updated the readme and contributing guide
-- Improved the GitLab CI/CD
+- Add Heart CLI as a peer dependency: it must be installed to make this module usable
+- Upgrade the minimum required version of Node.js to the active LTS: from >=8.0.0 to >=10.13.0
+- Improve compatibility: starting from this version, every Heart module shares the same major version number
 
-### Fixed
-- NPM permissions from the GitLab CI/CD
+### Minor changes
 
-## [1.0.0] - 2019-04-10
-### Added
-- First release (Yay!)
+- Improve the module installation: it can now be installed as a devDependency
+- Add environment variable creation from a .env file
+
+### Patches
+
+- Remove the contributing guide and the license: they are now available in the Heart repository
+- Remove unnecessary dependencies and scripts from package.json
+- Update the readme to reflect the changes introduced by this major release
+

lib/api/Client.d.ts

@@ -7,3 +7,3 @@ import Scan from './model/Scan.js';
     constructor();
-    launchAnalysis(conf: any): Promise<Scan>;
+    launchAnalysis(conf: object): Promise<Scan>;
     getProjectHost(): string;
@@ -10,0 +10,0 @@ getAnalyzeUrl(): string;

lib/api/Client.js

@@ -19,4 +19,3 @@ "use strict";
         return __awaiter(this, void 0, void 0, function* () {
-            /** @deprecated conf['project_url'] use conf['host'] */
-            this.host = conf['host'] || conf['project_url'];
+            this.host = conf['host'];
             if (undefined === this.host) {
@@ -28,5 +27,2 @@ return Promise.reject({
             }
-            // Remove unused properties for POST parameters
-            delete conf.host;
-            delete conf.project_url;
             return heart_core_1.Request.post(this.generateApiUrl('analyze'), conf, {
@@ -33,0 +29,0 @@ [heart_core_1.Request.HEADER_CONTENT_TYPE]: heart_core_1.Request.HEADER_CONTENT_TYPE_X_WWW_FORM_URLENCODED

lib/index.d.ts

@@ -1,2 +0,3 @@
-import Analysis from './Analysis.js';
-export { Analysis };
+import ObservatoryModule from './ObservatoryModule.js';
+declare const _default: ObservatoryModule;
+export default _default;

lib/index.js

@@ -6,4 +6,9 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const Analysis_js_1 = __importDefault(require("./Analysis.js"));
-exports.Analysis = Analysis_js_1.default;
+const ObservatoryModule_js_1 = __importDefault(require("./ObservatoryModule.js"));
+exports.default = new ObservatoryModule_js_1.default({
+    name: 'Heart Observatory',
+    service: {
+        name: 'Mozilla Observatory',
+    },
+});
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@fabernovel/heart-observatory",
-  "version": "1.2.1",
-  "description": "Analyze an url using the Mozilla Observatory service",
-  "homepage": "https://gitlab.com/fabernovel/heart/heart-observatory",
+  "version": "3.0.1",
+  "description": "Analysis module of Heart, which analyses URLs with Mozilla Observatory",
+  "homepage": "https://gitlab.com/fabernovel/heart",
   "bugs": {
-    "url": "https://gitlab.com/fabernovel/heart/heart-observatory/issues"
+    "url": "https://gitlab.com/fabernovel/heart/issues"
   },
   "repository": {
     "type": "git",
-    "url": "https://gitlab.com/fabernovel/heart/heart-observatory.git"
+    "url": "https://gitlab.com/fabernovel/heart.git"
   },
@@ -28,24 +28,21 @@ "license": "MIT",
     "build": "tsc",
-    "dev": "tsc -w",
-    "format": "sort-package-json",
+    "build-watch": "tsc -w",
     "lint": "tslint -c tslint.json -p tsconfig.json",
     "prepare": "npm run build",
-    "prepublishOnly": "npm run lint",
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "preversion": "npm run lint",
-    "version": "npm run format && git add -A src",
-    "postversion": "git push && git push --tags"
+    "test": "echo \"Error: no test specified\" && exit 1"
   },
+  "engines": {
+    "node": ">=10.13.0"
+  },
   "dependencies": {
-    "@fabernovel/heart-core": "^1.5.0"
+    "@fabernovel/heart-core": "^3.0.1"
   },
   "devDependencies": {
-    "@types/node": "^10.14.4",
-    "sort-package-json": "^1.22.1",
-    "tslint": "^5.17.0",
+    "@types/node": "^10.14.10",
+    "tslint": "^5.18.0",
     "typescript": "^3.5.2"
   },
-  "engines": {
-    "node": ">=8.0.0"
+  "peerDependencies": {
+    "@fabernovel/heart-cli": "^3.0.0"
   }
 }

README.md

 # Description
 
-_Heart Observatory_ is an _analysis_ module of _Heart_, which analyses URLs by using the _[Mozilla Observatory](https://observatory.mozilla.org/)_ service.
+_Heart Observatory_ is an _analysis_ module of _Heart_, which analyses URLs with _[Mozilla Observatory](https://observatory.mozilla.org/)_.
 
-Note that you must have installed a _runner_ module too.
+Read more about the purpose, design and general installation of _Heart_ on [the dedicated wiki](https://gitlab.com/fabernovel/heart/wikis/What-is-Heart).
 
-Read more about the purpose, design and general installation of _Heart_ on [the dedicated wiki](https://gitlab.com/fabernovel/heart-deprecated/heart-dev/wikis/What-is-Heart).
+# Package manager
 
+In the following sections, every examples are using NPM as package manager, but you can use any other you prefer: Yarn, pnpm...
+
 # Installation
@@ -17,5 +19,11 @@
 
-2. Add the API and results URLs as environment variables:
+2. Add _[Heart CLI](https://www.npmjs.com/package/@fabernovel/heart-cli)_ if you have not already installed it
 
     ```shell
+    npm install @fabernovel/heart-cli
+    ```
+
+3. In the project root folder, create a `.env` file with the API and results URLs:
+
+    ```dotenv
     OBSERVATORY_API_URL=https://http-observatory.security.mozilla.org/api/v1/
@@ -49,3 +57,3 @@ OBSERVATORY_ANALYZE_URL=https://observatory.mozilla.org/analyze/
 
-> The _[Heart API](https://www.npmjs.com/package/@fabernovel/heart-dareboost)_ _runner_ module is installed
+> The _[Heart API](https://www.npmjs.com/package/@fabernovel/heart-api)_ _runner_ module is installed
 >
@@ -52,0 +60,0 @@ > The server is listening on port 3000

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

Improved metrics

Total package byte prevSize

16677

increased by4.74%

Dev dependency count

3

decreased by-25%

Lines of code

241

increased by31.69%

Number of lines in readme file

71

increased by12.7%

Worsened metrics

Dependency count

2

increased by100%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@fabernovel/heart-cli@3.3.0(transitive)

• + Added@fabernovel/heart-core@3.3.0(transitive)

• + Addedansi-regex@5.0.1(transitive)

• + Addedansi-styles@4.3.0(transitive)

• + Addedbase64-js@1.5.1(transitive)

• + Addedbl@4.1.0(transitive)

• + Addedbuffer@5.7.1(transitive)

• + Addedchalk@4.1.2(transitive)

• + Addedcli-cursor@3.1.0(transitive)

• + Addedcli-spinners@2.9.2(transitive)

• + Addedclone@1.0.4(transitive)

• + Addedcolor-convert@2.0.1(transitive)

• + Addedcolor-name@1.1.4(transitive)

• + Addedcommander@9.5.0(transitive)

• + Addeddefaults@1.0.4(transitive)

• + Addeddotenv@8.6.0(transitive)

• + Addedhas-flag@4.0.0(transitive)

• + Addedieee754@1.2.1(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedis-interactive@1.0.0(transitive)

• + Addedis-unicode-supported@0.1.0(transitive)

• + Addedlog-symbols@4.1.0(transitive)

• + Addedmimic-fn@2.1.0(transitive)

• + Addedonetime@5.1.2(transitive)

• + Addedora@5.4.1(transitive)

• + Addedreadable-stream@3.6.2(transitive)

• + Addedrestore-cursor@3.1.0(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedsignal-exit@3.0.7(transitive)

• + Addedstring_decoder@1.3.0(transitive)

• + Addedstrip-ansi@6.0.1(transitive)

• + Addedsupports-color@7.2.0(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addedwcwidth@1.0.1(transitive)

• - Removed@fabernovel/heart-core@1.5.1(transitive)

• - Removedapp-root-path@2.2.1(transitive)

• - Removeddotenv@7.0.0(transitive)

• Updated@fabernovel/heart-core@^3.0.1