@mongodb-js/compass-utils - npm Package Compare versions

Comparing version 0.0.0-next-c787db5509648c04a843991556d9d2f4af0e3db5 to 0.0.0-next-c7c05844ab1acbff2d36a3ec8ff443cb829e88e0

dist/cancellable-promise.d.ts

 declare class AbortError extends Error {
-    constructor();
+    constructor(message?: string);
     name: string;
 }
-export declare const throwIfAborted: (signal?: AbortSignal) => void;
-export declare const createCancelError: () => AbortError;
+export declare const throwIfAborted: (signal?: {
+    aborted: boolean;
+    reason?: Error;
+}) => void;
+export declare const createCancelError: (message?: string) => AbortError;
 export declare function isCancelError(error: any): error is AbortError;
 export declare function raceWithAbort<T>(promise: Promise<T>, signal: AbortSignal): Promise<T>;
+/**
+ * Returns a promise that waits for a timeout and can be canceled with a signal
+ *
+ * @param ms Wait time
+ * @param signal Abort signal
+ */
 export declare function cancellableWait(ms: number, signal: AbortSignal): Promise<void>;
 export {};
 //# sourceMappingURL=cancellable-promise.d.ts.map

dist/cancellable-promise.js

@@ -5,4 +5,4 @@ "use strict";
 class AbortError extends Error {
-    constructor() {
-        super('This operation was aborted');
+    constructor(message) {
+        super(message ?? 'This operation was aborted');
         this.name = 'AbortError';
@@ -17,6 +17,16 @@ }
 exports.throwIfAborted = throwIfAborted;
-const createCancelError = () => {
+const createCancelError = (message) => {
     const controller = new AbortController();
     controller.abort();
-    return controller.signal.reason ?? new AbortError();
+    if (message && controller.signal.reason) {
+        Object.defineProperty(controller.signal.reason, 'message', {
+            get() {
+                return message;
+            },
+            configurable: true,
+            enumerable: true,
+        });
+    }
+    // .reason is not supported in all electron versions, so use AbortError as a fallback
+    return controller.signal.reason ?? new AbortError(message);
 };
@@ -33,2 +43,3 @@ exports.createCancelError = createCancelError;
     let abortListener;
+    // We need a promise that will reject as soon as the operation is aborted.
     const pendingPromise = new Promise((_resolve, reject) => {
@@ -46,2 +57,8 @@ abortListener = () => reject(signal.reason ?? (0, exports.createCancelError)());
 exports.raceWithAbort = raceWithAbort;
+/**
+ * Returns a promise that waits for a timeout and can be canceled with a signal
+ *
+ * @param ms Wait time
+ * @param signal Abort signal
+ */
 async function cancellableWait(ms, signal) {
@@ -48,0 +65,0 @@ await raceWithAbort(new Promise((resolve) => {

dist/electron.d.ts

 export declare function getAppName(): string | undefined;
+export declare function getAppVersion(): string | undefined;
 export declare function getStoragePath(): string;
 //# sourceMappingURL=electron.d.ts.map

dist/electron.js

 "use strict";
+/* eslint-disable @typescript-eslint/no-var-requires */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStoragePath = exports.getAppName = void 0;
+exports.getStoragePath = exports.getAppVersion = exports.getAppName = void 0;
 function getElectronApp() {
@@ -14,2 +15,3 @@ let app;
         catch (e2) {
+            // eslint-disable-next-line no-console
             console.log('Could not load @electron/remote', e1.message, e2.message);
@@ -24,2 +26,6 @@ }
 exports.getAppName = getAppName;
+function getAppVersion() {
+    return getElectronApp()?.getVersion();
+}
+exports.getAppVersion = getAppVersion;
 function getStoragePath() {
@@ -26,0 +32,0 @@ const basepath = getElectronApp()?.getPath('userData');

dist/index.d.ts

@@ -1,4 +0,5 @@
-export { AmpersandMethodOptions, promisifyAmpersandMethod, } from './promisify-ampersand-method';
-export { getAppName, getStoragePath } from './electron';
+export type { AmpersandMethodOptions } from './promisify-ampersand-method';
+export { promisifyAmpersandMethod } from './promisify-ampersand-method';
+export { getAppName, getStoragePath, getAppVersion } from './electron';
 export { raceWithAbort, cancellableWait, createCancelError, isCancelError, throwIfAborted, } from './cancellable-promise';
 //# sourceMappingURL=index.d.ts.map

dist/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.throwIfAborted = exports.isCancelError = exports.createCancelError = exports.cancellableWait = exports.raceWithAbort = exports.getStoragePath = exports.getAppName = exports.promisifyAmpersandMethod = void 0;
+exports.throwIfAborted = exports.isCancelError = exports.createCancelError = exports.cancellableWait = exports.raceWithAbort = exports.getAppVersion = exports.getStoragePath = exports.getAppName = exports.promisifyAmpersandMethod = void 0;
 var promisify_ampersand_method_1 = require("./promisify-ampersand-method");
@@ -9,2 +9,3 @@ Object.defineProperty(exports, "promisifyAmpersandMethod", { enumerable: true, get: function () { return promisify_ampersand_method_1.promisifyAmpersandMethod; } });
 Object.defineProperty(exports, "getStoragePath", { enumerable: true, get: function () { return electron_1.getStoragePath; } });
+Object.defineProperty(exports, "getAppVersion", { enumerable: true, get: function () { return electron_1.getAppVersion; } });
 var cancellable_promise_1 = require("./cancellable-promise");
@@ -11,0 +12,0 @@ Object.defineProperty(exports, "raceWithAbort", { enumerable: true, get: function () { return cancellable_promise_1.raceWithAbort; } });

package.json

 {
   "name": "@mongodb-js/compass-utils",
-  "productName": "compass-utils Plugin",
   "description": "Utilities for MongoDB Compass Development",
@@ -17,3 +16,3 @@ "author": {
   "homepage": "https://github.com/mongodb-js/compass",
-  "version": "0.0.0-next-c787db5509648c04a843991556d9d2f4af0e3db5",
+  "version": "0.0.0-next-c7c05844ab1acbff2d36a3ec8ff443cb829e88e0",
   "repository": {
@@ -45,3 +44,3 @@ "type": "git",
     "lint": "npm run eslint . && npm run prettier -- --check .",
-    "depcheck": "depcheck",
+    "depcheck": "compass-scripts check-peer-deps && depcheck",
     "check": "npm run typecheck && npm run lint && npm run depcheck",
@@ -53,13 +52,9 @@ "check-ci": "npm run check",
     "test-ci": "npm run test-cov",
-    "reformat": "npm run prettier -- --write . && npm run eslint . --fix"
+    "reformat": "npm run eslint . -- --fix && npm run prettier -- --write ."
   },
-  "optionalDependencies": {
-    "@electron/remote": "^2.0.12",
-    "electron": "^25.9.3"
-  },
   "devDependencies": {
-    "@mongodb-js/eslint-config-compass": "0.0.0-next-c787db5509648c04a843991556d9d2f4af0e3db5",
-    "@mongodb-js/mocha-config-compass": "0.0.0-next-c787db5509648c04a843991556d9d2f4af0e3db5",
-    "@mongodb-js/prettier-config-compass": "0.0.0-next-c787db5509648c04a843991556d9d2f4af0e3db5",
-    "@mongodb-js/tsconfig-compass": "0.0.0-next-c787db5509648c04a843991556d9d2f4af0e3db5",
+    "@mongodb-js/eslint-config-compass": "0.0.0-next-c7c05844ab1acbff2d36a3ec8ff443cb829e88e0",
+    "@mongodb-js/mocha-config-compass": "0.0.0-next-c7c05844ab1acbff2d36a3ec8ff443cb829e88e0",
+    "@mongodb-js/prettier-config-compass": "0.0.0-next-c7c05844ab1acbff2d36a3ec8ff443cb829e88e0",
+    "@mongodb-js/tsconfig-compass": "0.0.0-next-c7c05844ab1acbff2d36a3ec8ff443cb829e88e0",
     "@types/chai": "^4.2.21",
@@ -78,3 +73,7 @@ "@types/mocha": "^9.0.0",
   },
-  "gitHead": "c787db5509648c04a843991556d9d2f4af0e3db5"
+  "dependencies": {
+    "@electron/remote": "^2.1.2",
+    "electron": "^30.5.1"
+  },
+  "gitHead": "c7c05844ab1acbff2d36a3ec8ff443cb829e88e0"
 }

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

47134

increased by4.42%

Lines of code

175

increased by25.9%

Dependency changes

• + Added@electron/remote@^2.1.2

• + Addedelectron@^30.5.1

• + Added@types/node@20.17.11(transitive)

• + Addedelectron@30.5.1(transitive)

• + Addedundici-types@6.19.8(transitive)

• - Removed@types/node@18.19.69(transitive)

• - Removedelectron@25.9.8(transitive)

• - Removedundici-types@5.26.5(transitive)