@renovatebot/osv-offline 1.2.12 → 1.3.0

package/README.md

@@ -3,7 +3,6 @@
 [![Package version](https://img.shields.io/npm/v/@renovatebot/osv-offline?style=for-the-badge)](https://www.npmjs.com/package/@renovatebot/osv-offline)
 [![Build status](https://img.shields.io/github/actions/workflow/status/renovatebot/osv-offline/build.yml?branch=main&style=for-the-badge)](https://github.com/renovatebot/osv-offline/actions/workflows/build.yml)
 [![MIT license](https://img.shields.io/badge/license-MIT-blue?style=for-the-badge)](./LICENSE)
-![Stability experimental](https://img.shields.io/badge/stability-experimental-orange.svg?style=for-the-badge)
 
 ## License
 

package/dist/lib/download.d.ts

@@ -1 +1,2 @@
-export declare function tryDownloadDb(): Promise<boolean>;
+import { Result } from './types';
+export declare function tryDownloadDb(): Promise<Result>;

package/dist/lib/download.js

@@ -14,6 +14,7 @@ const osv_offline_db_1 = require("@renovatebot/osv-offline-db");
 const path_1 = __importDefault(require("path"));
 const luxon_1 = require("luxon");
 const adm_zip_1 = __importDefault(require("adm-zip"));
+const types_1 = require("./types");
 const pipeline = (0, util_1.promisify)(stream_1.Stream.pipeline);
 const baseParameters = {
     owner: 'renovatebot',
@@ -31,9 +32,12 @@ async function tryDownloadDb() {
     }
     if (stats !== undefined &&
         luxon_1.DateTime.utc().diff(luxon_1.DateTime.fromJSDate(stats.mtime)).as('days') < 1) {
-        return true;
+        return (0, types_1.success)();
     }
-    const octokitOptions = { auth: process.env['GITHUB_COM_TOKEN'], request: { fetch: node_fetch_1.default } };
+    const octokitOptions = {
+        auth: process.env['GITHUB_COM_TOKEN'],
+        request: { fetch: node_fetch_1.default },
+    };
     let latestRelease = null;
     try {
         latestRelease = (await new rest_1.Octokit(octokitOptions).repos.listReleases({
@@ -41,12 +45,12 @@ async function tryDownloadDb() {
         })).data[0];
     }
     catch (err) {
-        return false;
+        return (0, types_1.failure)(err);
     }
     const asset = latestRelease?.assets.find((asset) => asset.name === 'osv-offline.zip');
     // if local database is the same size as remote database, don't download again
     if (asset?.size === stats?.size) {
-        return true;
+        return (0, types_1.success)();
     }
     if (asset !== undefined) {
         // only download databases if local databases are missing or remote is newer
@@ -59,9 +63,9 @@ async function tryDownloadDb() {
             zip.extractAllTo(osv_offline_db_1.OsvOfflineDb.rootDirectory);
         }
         catch (err) {
-            return false;
+            return (0, types_1.failure)(err);
         }
     }
-    return true;
+    return (0, types_1.success)();
 }
 exports.tryDownloadDb = tryDownloadDb;

package/dist/lib/osv-offline.js

@@ -11,9 +11,9 @@ class OsvOffline {
      * Asynchronous code required as part of class instantiation
      */
     async initialize() {
-        const success = await (0, download_1.tryDownloadDb)();
-        if (!success) {
-            throw new Error();
+        const result = await (0, download_1.tryDownloadDb)();
+        if (!result.success) {
+            throw result.error;
         }
         this.osvOfflineDb = await osv_offline_db_1.OsvOfflineDb.create();
     }

package/dist/lib/types.d.ts

@@ -0,0 +1,11 @@
+type Success = {
+    success: true;
+};
+type Failure = {
+    success: false;
+    error: Error;
+};
+export type Result = Success | Failure;
+export declare function success(): Success;
+export declare function failure(error: Error): Failure;
+export {};

package/dist/lib/types.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.failure = exports.success = void 0;
+function success() {
+    return { success: true };
+}
+exports.success = success;
+function failure(error) {
+    return { success: false, error };
+}
+exports.failure = failure;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@renovatebot/osv-offline",
-  "version": "1.2.12",
+  "version": "1.3.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
@@ -9,7 +9,7 @@
   },
   "dependencies": {
     "@renovatebot/osv-offline-db": "1.4.0",
-    "@octokit/rest": "^19.0.11",
+    "@octokit/rest": "^19.0.13",
     "adm-zip": "~0.5.10",
     "fs-extra": "^11.1.1",
     "got": "^11.8.6",
@@ -20,10 +20,10 @@
     "@types/adm-zip": "0.5.0",
     "@types/fs-extra": "11.0.1",
     "@types/luxon": "3.3.0",
-    "@types/node": "18.16.13",
+    "@types/node": "18.16.16",
     "@types/node-fetch": "2.6.4",
     "prettier": "2.8.8",
     "ts-node": "10.9.1",
-    "typescript": "5.0.4"
+    "typescript": "5.1.3"
   }
 }