@ledgerhq/wallet-api-feature-flag-module 0.2.0-nightly.20260123024457

package/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017-present Ledger https://www.ledger.com/
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/lib/index.d.ts

@@ -0,0 +1,24 @@
+import { CustomModule } from "@ledgerhq/wallet-api-client";
+import { Feature } from "./types";
+export * from "./types";
+export declare class FeatureFlagModule extends CustomModule {
+    /**
+     * Fetch feature flags from Ledger Live.
+     *
+     * The Live App must declare which feature flags it can access via the
+     * `featureFlags` array in its manifest. Only declared flags will be returned.
+     *
+     * @param featureFlagIds - Array of feature flag IDs to fetch
+     * @returns A record mapping feature flag IDs to their values, or null if not found/unauthorized
+     *
+     * @example
+     * ```typescript
+     * const result = await featureFlagModule.get(["stakePrograms", "earnLidoStaking"]);
+     * if (result.features.stakePrograms?.enabled) {
+     *   // Feature is enabled
+     * }
+     * ```
+     */
+    get(featureFlagIds: string[]): Promise<Record<string, Feature<unknown> | null>>;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAA8C,OAAO,EAAE,MAAM,SAAS,CAAC;AAE9E,cAAc,SAAS,CAAC;AAExB,qBAAa,iBAAkB,SAAQ,YAAY;IACjD;;;;;;;;;;;;;;;;OAgBG;IACG,GAAG,CAAC,cAAc,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;CAStF"}

package/lib/index.js

@@ -0,0 +1,46 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeatureFlagModule = void 0;
+const wallet_api_client_1 = require("@ledgerhq/wallet-api-client");
+__exportStar(require("./types"), exports);
+class FeatureFlagModule extends wallet_api_client_1.CustomModule {
+    /**
+     * Fetch feature flags from Ledger Live.
+     *
+     * The Live App must declare which feature flags it can access via the
+     * `featureFlags` array in its manifest. Only declared flags will be returned.
+     *
+     * @param featureFlagIds - Array of feature flag IDs to fetch
+     * @returns A record mapping feature flag IDs to their values, or null if not found/unauthorized
+     *
+     * @example
+     * ```typescript
+     * const result = await featureFlagModule.get(["stakePrograms", "earnLidoStaking"]);
+     * if (result.features.stakePrograms?.enabled) {
+     *   // Feature is enabled
+     * }
+     * ```
+     */
+    async get(featureFlagIds) {
+        const result = await this.request("custom.featureFlags.get", {
+            featureFlagIds,
+        });
+        return result.features;
+    }
+}
+exports.FeatureFlagModule = FeatureFlagModule;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,mEAA2D;AAG3D,0CAAwB;AAExB,MAAa,iBAAkB,SAAQ,gCAAY;IACjD;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,GAAG,CAAC,cAAwB;QAChC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAC/B,yBAAyB,EACzB;YACE,cAAc;SACf,CACF,CAAC;QACF,OAAO,MAAM,CAAC,QAAQ,CAAC;IACzB,CAAC;CACF;AA3BD,8CA2BC"}

package/lib/types.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Represents a feature flag value returned by Ledger Live.
+ * This is a simplified version of the Feature type for Live Apps.
+ */
+export type Feature<T = unknown> = {
+    /**
+     * If false, the feature is disabled
+     */
+    enabled: boolean;
+    /**
+     * Additional parameters specific to this feature flag
+     */
+    params?: T;
+};
+export type FeatureFlagGetParams = {
+    featureFlagIds: string[];
+};
+export type FeatureFlagGetResult = {
+    features: Record<string, Feature<unknown> | null>;
+};
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,GAAG,OAAO,IAAI;IACjC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;CACnD,CAAC"}

package/lib/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/lib-es/index.d.ts

@@ -0,0 +1,24 @@
+import { CustomModule } from "@ledgerhq/wallet-api-client";
+import { Feature } from "./types";
+export * from "./types";
+export declare class FeatureFlagModule extends CustomModule {
+    /**
+     * Fetch feature flags from Ledger Live.
+     *
+     * The Live App must declare which feature flags it can access via the
+     * `featureFlags` array in its manifest. Only declared flags will be returned.
+     *
+     * @param featureFlagIds - Array of feature flag IDs to fetch
+     * @returns A record mapping feature flag IDs to their values, or null if not found/unauthorized
+     *
+     * @example
+     * ```typescript
+     * const result = await featureFlagModule.get(["stakePrograms", "earnLidoStaking"]);
+     * if (result.features.stakePrograms?.enabled) {
+     *   // Feature is enabled
+     * }
+     * ```
+     */
+    get(featureFlagIds: string[]): Promise<Record<string, Feature<unknown> | null>>;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib-es/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAA8C,OAAO,EAAE,MAAM,SAAS,CAAC;AAE9E,cAAc,SAAS,CAAC;AAExB,qBAAa,iBAAkB,SAAQ,YAAY;IACjD;;;;;;;;;;;;;;;;OAgBG;IACG,GAAG,CAAC,cAAc,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;CAStF"}

package/lib-es/index.js

@@ -0,0 +1,28 @@
+import { CustomModule } from "@ledgerhq/wallet-api-client";
+export * from "./types";
+export class FeatureFlagModule extends CustomModule {
+    /**
+     * Fetch feature flags from Ledger Live.
+     *
+     * The Live App must declare which feature flags it can access via the
+     * `featureFlags` array in its manifest. Only declared flags will be returned.
+     *
+     * @param featureFlagIds - Array of feature flag IDs to fetch
+     * @returns A record mapping feature flag IDs to their values, or null if not found/unauthorized
+     *
+     * @example
+     * ```typescript
+     * const result = await featureFlagModule.get(["stakePrograms", "earnLidoStaking"]);
+     * if (result.features.stakePrograms?.enabled) {
+     *   // Feature is enabled
+     * }
+     * ```
+     */
+    async get(featureFlagIds) {
+        const result = await this.request("custom.featureFlags.get", {
+            featureFlagIds,
+        });
+        return result.features;
+    }
+}
+//# sourceMappingURL=index.js.map

package/lib-es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAG3D,cAAc,SAAS,CAAC;AAExB,MAAM,OAAO,iBAAkB,SAAQ,YAAY;IACjD;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,GAAG,CAAC,cAAwB;QAChC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAC/B,yBAAyB,EACzB;YACE,cAAc;SACf,CACF,CAAC;QACF,OAAO,MAAM,CAAC,QAAQ,CAAC;IACzB,CAAC;CACF"}

package/lib-es/package.json

@@ -0,0 +1 @@
+{ "type": "module" }

package/lib-es/types.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Represents a feature flag value returned by Ledger Live.
+ * This is a simplified version of the Feature type for Live Apps.
+ */
+export type Feature<T = unknown> = {
+    /**
+     * If false, the feature is disabled
+     */
+    enabled: boolean;
+    /**
+     * Additional parameters specific to this feature flag
+     */
+    params?: T;
+};
+export type FeatureFlagGetParams = {
+    featureFlagIds: string[];
+};
+export type FeatureFlagGetResult = {
+    features: Record<string, Feature<unknown> | null>;
+};
+//# sourceMappingURL=types.d.ts.map

package/lib-es/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,GAAG,OAAO,IAAI;IACjC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;CACnD,CAAC"}

package/lib-es/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/lib-es/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@ledgerhq/wallet-api-feature-flag-module",
+  "version": "0.2.0-nightly.20260123024457",
+  "description": "Wallet-API Feature Flag Module for Ledger Live",
+  "license": "Apache-2.0",
+  "keywords": [
+    "Ledger"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/LedgerHQ/ledger-live.git"
+  },
+  "bugs": {
+    "url": "https://github.com/LedgerHQ/ledger-live/issues"
+  },
+  "homepage": "https://github.com/LedgerHQ/ledger-live/tree/develop/libs/feature-flag-module",
+  "main": "lib/index.js",
+  "module": "lib-es/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "/lib",
+    "/lib-es"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@ledgerhq/wallet-api-client": "^1.12.6",
+    "@ledgerhq/wallet-api-core": "^1.27.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.10"
+  },
+  "scripts": {
+    "clean": "rimraf lib lib-es",
+    "build": "tsc && tsc -m esnext --moduleResolution bundler --outDir lib-es && node scripts/createModulePackage.mjs",
+    "prewatch": "pnpm build",
+    "watch": "tsc --watch",
+    "watch:es": "tsc --watch -m esnext --moduleResolution bundler --outDir lib-es",
+    "lint": "eslint ./src --no-error-on-unmatched-pattern --ext .ts,.tsx",
+    "lint:fix": "pnpm lint --fix"
+  }
+}