@ledgerhq/coin-module-framework 2.0.2 → 2.1.0

package/.unimportedrc.json

@@ -1,10 +1,5 @@
 {
-  "entry": [
-    "src/api/index.ts",
-    "src/currencies/index.ts",
-    "src/index.ts",
-    "src/utils.ts"
-  ],
+  "entry": ["src/api/index.ts", "src/currencies/index.ts", "src/index.ts", "src/utils.ts"],
   "ignoreUnimported": [
     "src/api/errors.ts",
     "src/api/index.ts",
@@ -17,16 +12,9 @@
     "src/features/types.ts",
     "src/setup.ts",
     "src/test/utils.ts",
-    "src/utils.ts"
-  ],
-  "ignoreUnresolved": [
-    "src/features/types.ts",
-    "src/setup.ts",
-    "src/utils.ts"
+    "src/utils.ts",
+    "src/api/getBalance/rejectBalanceOptions.ts"
   ],
-  "ignoreUnused": [
-    "@ledgerhq/errors",
-    "@ledgerhq/live-env",
-    "expect"
-  ]
-}
+  "ignoreUnresolved": ["src/features/types.ts", "src/setup.ts", "src/utils.ts"],
+  "ignoreUnused": ["@ledgerhq/errors", "@ledgerhq/live-env", "expect"]
+}

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ledgerhq/coin-module-framework
 
+## 2.1.0
+
+### Minor Changes
+
+- [#488](https://github.com/LedgerHQ/alpaca-coin-module/pull/488) [`5b1c71a`](https://github.com/LedgerHQ/alpaca-coin-module/commit/5b1c71a1675b4cc9f491403a97fdef46a71f10ea) Thanks [@Moustafa-Koterba](https://github.com/Moustafa-Koterba)! - Add a common function to reject BalanceOptions on getBalance
+
+## 2.0.3
+
+### Patch Changes
+
+- [#500](https://github.com/LedgerHQ/alpaca-coin-module/pull/500) [`9b2ea00`](https://github.com/LedgerHQ/alpaca-coin-module/commit/9b2ea0026a384ade9e63d6378de8a3a69efd1e3a) Thanks [@francois-guerin-ledger](https://github.com/francois-guerin-ledger)! - chore(coin-module-framework): blank changeset
+
 ## 2.0.2
 
 ### Patch Changes

package/lib/api/getBalance/rejectBalanceOptions.d.ts

@@ -0,0 +1,11 @@
+import { Balance, BalanceOptions } from '../types';
+/**
+ * Wraps a balance fetcher that does not support {@link BalanceOptions}
+ *
+ * @param getBalance function that returns {@link Balance}[] without applying options
+ * @param options must be undefined; any defined value is rejected
+ * @returns the promise returned by {@link getBalance}
+ * @throws an {@link InvalidParameterError} when {@link options} is provided
+ */
+export declare function rejectBalanceOptions(getBalance: () => Promise<Balance[]>, options?: BalanceOptions): Promise<Balance[]>;
+//# sourceMappingURL=rejectBalanceOptions.d.ts.map

package/lib/api/getBalance/rejectBalanceOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rejectBalanceOptions.d.ts","sourceRoot":"","sources":["../../../src/api/getBalance/rejectBalanceOptions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAElD;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CACxC,UAAU,EAAE,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,OAAO,EAAE,CAAC,CAMpB"}

package/lib/api/getBalance/rejectBalanceOptions.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rejectBalanceOptions = rejectBalanceOptions;
+const errors_1 = require("@ledgerhq/errors");
+/**
+ * Wraps a balance fetcher that does not support {@link BalanceOptions}
+ *
+ * @param getBalance function that returns {@link Balance}[] without applying options
+ * @param options must be undefined; any defined value is rejected
+ * @returns the promise returned by {@link getBalance}
+ * @throws an {@link InvalidParameterError} when {@link options} is provided
+ */
+async function rejectBalanceOptions(getBalance, options) {
+    if (options) {
+        throw new errors_1.InvalidParameterError('getBalance does not support the options parameter');
+    }
+    return getBalance();
+}
+//# sourceMappingURL=rejectBalanceOptions.js.map

package/lib/api/getBalance/rejectBalanceOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rejectBalanceOptions.js","sourceRoot":"","sources":["../../../src/api/getBalance/rejectBalanceOptions.ts"],"names":[],"mappings":";;AAWA,oDASC;AApBD,6CAAwD;AAGxD;;;;;;;GAOG;AACI,KAAK,UAAU,oBAAoB,CACxC,UAAoC,EACpC,OAAwB;IAExB,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,IAAI,8BAAqB,CAAC,mDAAmD,CAAC,CAAA;IACtF,CAAC;IAED,OAAO,UAAU,EAAE,CAAA;AACrB,CAAC"}

package/lib-es/api/getBalance/rejectBalanceOptions.d.ts

@@ -0,0 +1,11 @@
+import { Balance, BalanceOptions } from '../types';
+/**
+ * Wraps a balance fetcher that does not support {@link BalanceOptions}
+ *
+ * @param getBalance function that returns {@link Balance}[] without applying options
+ * @param options must be undefined; any defined value is rejected
+ * @returns the promise returned by {@link getBalance}
+ * @throws an {@link InvalidParameterError} when {@link options} is provided
+ */
+export declare function rejectBalanceOptions(getBalance: () => Promise<Balance[]>, options?: BalanceOptions): Promise<Balance[]>;
+//# sourceMappingURL=rejectBalanceOptions.d.ts.map

package/lib-es/api/getBalance/rejectBalanceOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rejectBalanceOptions.d.ts","sourceRoot":"","sources":["../../../src/api/getBalance/rejectBalanceOptions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAElD;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CACxC,UAAU,EAAE,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,OAAO,EAAE,CAAC,CAMpB"}

package/lib-es/api/getBalance/rejectBalanceOptions.js

@@ -0,0 +1,16 @@
+import { InvalidParameterError } from '@ledgerhq/errors';
+/**
+ * Wraps a balance fetcher that does not support {@link BalanceOptions}
+ *
+ * @param getBalance function that returns {@link Balance}[] without applying options
+ * @param options must be undefined; any defined value is rejected
+ * @returns the promise returned by {@link getBalance}
+ * @throws an {@link InvalidParameterError} when {@link options} is provided
+ */
+export async function rejectBalanceOptions(getBalance, options) {
+    if (options) {
+        throw new InvalidParameterError('getBalance does not support the options parameter');
+    }
+    return getBalance();
+}
+//# sourceMappingURL=rejectBalanceOptions.js.map

package/lib-es/api/getBalance/rejectBalanceOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rejectBalanceOptions.js","sourceRoot":"","sources":["../../../src/api/getBalance/rejectBalanceOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAA;AAGxD;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,UAAoC,EACpC,OAAwB;IAExB,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,IAAI,qBAAqB,CAAC,mDAAmD,CAAC,CAAA;IACtF,CAAC;IAED,OAAO,UAAU,EAAE,CAAA;AACrB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ledgerhq/coin-module-framework",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "Ledger framework for Coin integration",
   "keywords": [
     "Ledger",

package/src/api/getBalance/rejectBalanceOptions.test.ts

@@ -0,0 +1,19 @@
+import { InvalidParameterError } from '@ledgerhq/errors'
+import { BalanceOptions } from '../types'
+import { rejectBalanceOptions } from './rejectBalanceOptions'
+
+describe('rejectBalanceOptions', () => {
+  it('should throw an exception when options is provided', async () => {
+    const getBalance = jest.fn().mockResolvedValueOnce([])
+    await expect(rejectBalanceOptions(getBalance, {} as unknown as BalanceOptions)).rejects.toThrow(
+      InvalidParameterError
+    )
+    expect(getBalance).not.toHaveBeenCalled()
+  })
+
+  it('should call getBalance when options is not provided', async () => {
+    const getBalance = jest.fn().mockResolvedValueOnce([])
+    await expect(rejectBalanceOptions(getBalance)).resolves.toEqual([])
+    expect(getBalance).toHaveBeenCalledTimes(1)
+  })
+})

package/src/api/getBalance/rejectBalanceOptions.ts

@@ -0,0 +1,21 @@
+import { InvalidParameterError } from '@ledgerhq/errors'
+import { Balance, BalanceOptions } from '../types'
+
+/**
+ * Wraps a balance fetcher that does not support {@link BalanceOptions}
+ *
+ * @param getBalance function that returns {@link Balance}[] without applying options
+ * @param options must be undefined; any defined value is rejected
+ * @returns the promise returned by {@link getBalance}
+ * @throws an {@link InvalidParameterError} when {@link options} is provided
+ */
+export async function rejectBalanceOptions(
+  getBalance: () => Promise<Balance[]>,
+  options?: BalanceOptions
+): Promise<Balance[]> {
+  if (options) {
+    throw new InvalidParameterError('getBalance does not support the options parameter')
+  }
+
+  return getBalance()
+}