@ledgerhq/live-config 1.0.0-next.0

package/lib-es/featureFlags/mock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock.js","sourceRoot":"","sources":["../../src/featureFlags/mock.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAA4B,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAEvF,MAAM,UAAU,sBAAsB,CACpC,cAAmD;IAEnD,OAAO;QACL,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI;QACrB,UAAU,EAAE,CAAC,SAAoB,EAAE,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,IAAI;QACvE,eAAe,EAAE,GAAG,EAAE,GAAE,CAAC;QACzB,YAAY,EAAE,GAAG,EAAE,GAAE,CAAC;QACtB,aAAa,EAAE,GAAG,EAAE,GAAE,CAAC;KACxB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,qCAAqC,CACnD,kBAA4C;IAE5C,MAAM,4BAA4B,GAAmD,CAAC,EACpF,QAAQ,GACT,EAAE,EAAE,CAAC,oBAAC,oBAAoB,IAAC,KAAK,EAAE,kBAAkB,IAAG,QAAQ,CAAwB,CAAC;IACzF,OAAO,4BAA4B,CAAC;AACtC,CAAC;AAED,MAAM,CAAC,MAAM,sCAAsC,GAAG,qCAAqC,CACzF,sBAAsB,CAAC,EAAE,CAAC,CAC3B,CAAC"}

package/lib-es/featureFlags/useFeature.d.ts

@@ -0,0 +1,14 @@
+import { Feature, FeatureParam } from "@ledgerhq/types-live";
+/**
+ * Hook that returns the value of a feature flag based on its `featureId`.
+ *
+ * @dev do not modify this function to make it return a default arbitrary value
+ * instead of null, this should not be handled at this level.
+ *
+ * @param featureId
+ * @returns a feature flag value or null if the feature flag is not found
+ * (neither in the remote configuration, in the cache or in the local defaults).
+ */
+declare const useFeature: <T extends keyof import("@ledgerhq/types-live").CurrencyFeatures | "learn" | "brazePushNotifications" | "brazeLearn" | "llmNewDeviceSelection" | "llmNewFirmwareUpdateUx" | "ratingsPrompt" | "npsRatingsPrompt" | "counterValue" | "deviceInitialApps" | "buyDeviceFromLive" | "ptxEarn" | "depositNetworkBannerMobile" | "depositWithdrawBannerMobile" | "mockFeature" | "multibuyNavigation" | "syncOnboarding" | "walletConnectEntryPoint" | "customImage" | "referralProgramDiscoverCard" | "referralProgramDesktopBanner" | "referralProgramDesktopSidebar" | "referralProgramMobile" | "disableNftSend" | "disableNftLedgerMarket" | "disableNftRaribleOpensea" | "walletNftGallery" | "receiveStakingFlowConfigDesktop" | "ethStakingProviders" | "storyly" | "staxWelcomeScreen" | "postOnboardingClaimNft" | "postOnboardingAssetsTransfer" | "firebaseEnvironmentReadOnly" | "protectServicesMobile" | "protectServicesDesktop" | "ptxServiceCtaExchangeDrawer" | "ptxServiceCtaScreens" | "swapWalletApiPartnerList" | "stakePrograms" | "portfolioExchangeBanner" | "objkt" | "editEvmTx" | "stakeAccountBanner" | "newsfeedPage" | "domainInputResolution" | "discover" | "protectServicesDiscoverDesktop" | "transactionsAlerts" | "listAppsV2minor1" | "llmWalletQuickActions" | "cexDepositEntryPointsDesktop" | "cexDepositEntryPointsMobile" | "fetchAdditionalCoins" | "ptxSwapLiveApp" | "ptxSwapMoonpayProvider">(featureId: T) => Feature<FeatureParam<T>> | null;
+export default useFeature;
+//# sourceMappingURL=useFeature.d.ts.map

package/lib-es/featureFlags/useFeature.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFeature.d.ts","sourceRoot":"","sources":["../../src/featureFlags/useFeature.ts"],"names":[],"mappings":"AAEA,OAAO,EAAa,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAExE;;;;;;;;;GASG;AACH,QAAA,MAAM,UAAU,05CAIf,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/lib-es/featureFlags/useFeature.js

@@ -0,0 +1,19 @@
+import { useMemo } from "react";
+import { useFeatureFlags } from "./FeatureFlagsContext";
+/**
+ * Hook that returns the value of a feature flag based on its `featureId`.
+ *
+ * @dev do not modify this function to make it return a default arbitrary value
+ * instead of null, this should not be handled at this level.
+ *
+ * @param featureId
+ * @returns a feature flag value or null if the feature flag is not found
+ * (neither in the remote configuration, in the cache or in the local defaults).
+ */
+const useFeature = (featureId) => {
+    const featureFlags = useFeatureFlags();
+    const value = useMemo(() => featureFlags.getFeature(featureId), [featureFlags, featureId]);
+    return value;
+};
+export default useFeature;
+//# sourceMappingURL=useFeature.js.map

package/lib-es/featureFlags/useFeature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFeature.js","sourceRoot":"","sources":["../../src/featureFlags/useFeature.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAChC,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAGxD;;;;;;;;;GASG;AACH,MAAM,UAAU,GAAG,CAAsB,SAAY,EAAmC,EAAE;IACxF,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;IACvC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAC3F,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/lib-es/featureFlags/useFeature.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useFeature.test.d.ts.map

package/lib-es/featureFlags/useFeature.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFeature.test.d.ts","sourceRoot":"","sources":["../../src/featureFlags/useFeature.test.tsx"],"names":[],"mappings":""}

package/lib-es/featureFlags/useFeature.test.js

@@ -0,0 +1,22 @@
+import { renderHook } from "@testing-library/react-hooks";
+import useFeature from "./useFeature";
+import { makeMockedFeatureFlagsProviderWrapper, makeMockedContextValue } from "./mock";
+describe("useFeature hook", () => {
+    it("should return null if a flag is not defined remotely", () => {
+        const mockedFeatures = {};
+        const { result } = renderHook(() => useFeature("mockFeature"), {
+            wrapper: makeMockedFeatureFlagsProviderWrapper(makeMockedContextValue(mockedFeatures)),
+        });
+        expect(result.current).toBeNull();
+    });
+    it("should return the feature flag value if the feature flag is defined", () => {
+        const mockedFeatures = {
+            mockFeature: { enabled: true, params: { blabla: "hello" } },
+        };
+        const { result } = renderHook(() => useFeature("mockFeature"), {
+            wrapper: makeMockedFeatureFlagsProviderWrapper(makeMockedContextValue(mockedFeatures)),
+        });
+        expect(result.current).toBe(mockedFeatures.mockFeature);
+    });
+});
+//# sourceMappingURL=useFeature.test.js.map

package/lib-es/featureFlags/useFeature.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFeature.test.js","sourceRoot":"","sources":["../../src/featureFlags/useFeature.test.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,UAAU,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,qCAAqC,EAAE,sBAAsB,EAAE,MAAM,QAAQ,CAAC;AAEvF,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,cAAc,GAAG,EAAE,CAAC;QAC1B,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE;YAC7D,OAAO,EAAE,qCAAqC,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC;SACvF,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qEAAqE,EAAE,GAAG,EAAE;QAC7E,MAAM,cAAc,GAAG;YACrB,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;SAC5D,CAAC;QACF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE;YAC7D,OAAO,EAAE,qCAAqC,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC;SACvF,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib-es/featureFlags/useHasOverriddenFeatureFlags.d.ts

@@ -0,0 +1,6 @@
+/**
+ *
+ * @returns whether one or more flags are locally overridden
+ */
+export declare function useHasLocallyOverriddenFeatureFlags(): boolean;
+//# sourceMappingURL=useHasOverriddenFeatureFlags.d.ts.map

package/lib-es/featureFlags/useHasOverriddenFeatureFlags.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useHasOverriddenFeatureFlags.d.ts","sourceRoot":"","sources":["../../src/featureFlags/useHasOverriddenFeatureFlags.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,wBAAgB,mCAAmC,IAAI,OAAO,CAc7D"}

package/lib-es/featureFlags/useHasOverriddenFeatureFlags.js

@@ -0,0 +1,20 @@
+import { useMemo } from "react";
+import { useFeatureFlags } from "./FeatureFlagsContext";
+import { DEFAULT_FEATURES } from "./defaultFeatures";
+/**
+ *
+ * @returns whether one or more flags are locally overridden
+ */
+export function useHasLocallyOverriddenFeatureFlags() {
+    const { getFeature } = useFeatureFlags();
+    return useMemo(() => Object.entries(DEFAULT_FEATURES).some(([featureId]) => {
+        try {
+            const val = getFeature(featureId);
+            return (val === null || val === void 0 ? void 0 : val.overridesRemote) || (val === null || val === void 0 ? void 0 : val.overriddenByEnv);
+        }
+        catch (e) {
+            return false;
+        }
+    }), [getFeature]);
+}
+//# sourceMappingURL=useHasOverriddenFeatureFlags.js.map

package/lib-es/featureFlags/useHasOverriddenFeatureFlags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useHasOverriddenFeatureFlags.js","sourceRoot":"","sources":["../../src/featureFlags/useHasOverriddenFeatureFlags.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEhC,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAErD;;;GAGG;AACH,MAAM,UAAU,mCAAmC;IACjD,MAAM,EAAE,UAAU,EAAE,GAAG,eAAe,EAAE,CAAC;IACzC,OAAO,OAAO,CACZ,GAAG,EAAE,CACH,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,EAAE;QACpD,IAAI;YACF,MAAM,GAAG,GAAG,UAAU,CAAC,SAAsB,CAAC,CAAC;YAC/C,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,eAAe,MAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,eAAe,CAAA,CAAC;SACrD;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,KAAK,CAAC;SACd;IACH,CAAC,CAAC,EACJ,CAAC,UAAU,CAAC,CACb,CAAC;AACJ,CAAC"}

package/lib-es/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./featureFlags";
+//# 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,cAAc,gBAAgB,CAAC"}

package/lib-es/index.js

@@ -0,0 +1,2 @@
+export * from "./featureFlags";
+//# 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,cAAc,gBAAgB,CAAC"}

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@ledgerhq/live-config",
+  "version": "1.0.0-next.0",
+  "description": "Ledger Live configuration tools",
+  "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/live-config",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "lodash": "^4.17.21",
+    "@ledgerhq/errors": "^6.16.1-next.0",
+    "@ledgerhq/live-env": "^0.8.0-next.0",
+    "@ledgerhq/live-promise": "^0.0.3",
+    "@ledgerhq/logs": "^6.12.0",
+    "@ledgerhq/types-live": "^6.43.1-next.0"
+  },
+  "devDependencies": {
+    "@testing-library/react": "12",
+    "@testing-library/react-hooks": "^8.0.0",
+    "@types/invariant": "^2.2.35",
+    "@types/jest": "^29.5.4",
+    "@types/lodash": "^4.14.182",
+    "@types/node": "^20.2.5",
+    "jest": "^28.1.1",
+    "jest-environment-jsdom": "28",
+    "react": "^18.2.0",
+    "react-dom": "18.2.0",
+    "semver": "^7.3.5",
+    "ts-jest": "^28.0.5"
+  },
+  "typesVersions": {
+    "*": {
+      "*.json": [
+        "*.json"
+      ],
+      "*": [
+        "lib/*"
+      ],
+      "lib/*": [
+        "lib/*"
+      ],
+      "lib-es/*": [
+        "lib-es/*"
+      ]
+    }
+  },
+  "exports": {
+    "./lib/*": "./lib/*.js",
+    "./lib/*.js": "./lib/*.js",
+    "./lib-es/*": "./lib-es/*.js",
+    "./lib-es/*.js": "./lib-es/*.js",
+    "./*": {
+      "require": "./lib/*.js",
+      "default": "./lib-es/*.js"
+    },
+    "./*.js": {
+      "require": "./lib/*.js",
+      "default": "./lib-es/*.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "clean": "rimraf lib lib-es",
+    "build": "tsc && tsc -m ES6 --outDir lib-es",
+    "prewatch": "pnpm build",
+    "watch": "tsc --watch",
+    "lint": "eslint ./src --no-error-on-unmatched-pattern --ext .ts,.tsx",
+    "lint:fix": "pnpm lint --fix",
+    "test": "jest"
+  }
+}

package/src/featureFlags/FeatureFlagsContext.test.tsx

@@ -0,0 +1,13 @@
+import { renderHook } from "@testing-library/react-hooks";
+import { makeMockedContextValue, makeMockedFeatureFlagsProviderWrapper } from "./mock";
+import { useFeatureFlags } from "./FeatureFlagsContext";
+
+describe("useFeatureFlags hook", () => {
+  it("should return the context value if it is used inside a context provider", () => {
+    const mockedContextValue = makeMockedContextValue({});
+    const { result } = renderHook(() => useFeatureFlags(), {
+      wrapper: makeMockedFeatureFlagsProviderWrapper(mockedContextValue),
+    });
+    expect(result?.current).toStrictEqual(mockedContextValue);
+  });
+});

package/src/featureFlags/FeatureFlagsContext.tsx

@@ -0,0 +1,62 @@
+import { createContext, useContext } from "react";
+import type { FeatureId, Feature } from "@ledgerhq/types-live";
+
+export type FeatureFlagsContextValue = {
+  /**
+   *
+   * @param featureId featureId identifying a potential feature flag
+   * @returns true if and only if the parameter matches a feature that is configured.
+   */
+  isFeature: (featureId: string) => boolean;
+
+  /**
+   *
+   * @param featureId featureId identifying a feature flag
+   * @returns the value of the feature flag if it is defined (remotely or through a default value), otherwise returns null
+   */
+  getFeature: (featureId: FeatureId) => Feature | null;
+
+  /**
+   * function that allows to override the value of a feature flag
+   *
+   * @param featureId featureId identifying a feature flag
+   * @param newValue new value of the feature flag
+   * @returns undefined
+   */
+  overrideFeature: (featureId: FeatureId, newValue: Feature) => void;
+
+  /**
+   * resets the overridden feature flag value for a given featureId
+   * @param featureId featureId identifying a feature flag
+   * @returns undefined
+   */
+  resetFeature: (featureId: FeatureId) => void;
+  /**
+   * resets all the overridden feature flags
+   * @returns undefined
+   */
+  resetFeatures: () => void;
+};
+
+/**
+ * Context used for injecting the feature flagging implementation logic.
+ *
+ * @dev do not export this, it should be accessed exclusively through
+ * useFeatureFlags and FeatureFlagsProvider
+ */
+const FeatureFlagsContext = createContext<FeatureFlagsContextValue>({
+  isFeature: _ => false,
+  getFeature: _ => null,
+  overrideFeature: _ => {},
+  resetFeature: _ => {},
+  resetFeatures: () => {},
+});
+
+export const FeatureFlagsProvider = FeatureFlagsContext.Provider;
+
+/**
+ * Hook to consume a FeatureFlagsContext
+ */
+export function useFeatureFlags(): FeatureFlagsContextValue {
+  return useContext(FeatureFlagsContext);
+}

package/src/featureFlags/FeatureToggle.tsx

@@ -0,0 +1,22 @@
+import React, { ReactNode } from "react";
+
+import useFeature from "./useFeature";
+import type { FeatureId } from "@ledgerhq/types-live";
+
+type Props = {
+  featureId: FeatureId;
+  fallback?: ReactNode;
+  children?: ReactNode;
+};
+
+const FeatureToggle = ({ featureId, fallback, children }: Props): JSX.Element => {
+  const feature = useFeature(featureId);
+
+  if (!feature || !feature.enabled) {
+    return <>{fallback || null}</>;
+  }
+
+  return <>{children || null}</>;
+};
+
+export default FeatureToggle;

package/src/featureFlags/LiveConfig.ts

@@ -0,0 +1,45 @@
+// refer to https://github.com/firebase/firebase-js-sdk/blob/master/packages/remote-config/src/public_types.ts#L71 for the firebase config value interface
+export declare interface Value {
+  asBoolean(): boolean;
+  asNumber(): number;
+  asString(): string;
+}
+
+export class LiveConfig {
+  public appVersion?: string;
+  public platform?: string;
+  public environment?: string;
+  public providerGetvalueMethod?: { [provider: string]: (key: string) => Value };
+
+  private static instance: LiveConfig; // Singleton instance
+  private constructor() {}
+  public static init(config: { appVersion: string; platform: string; environment: string }) {
+    if (!LiveConfig.instance) {
+      LiveConfig.instance = new LiveConfig();
+      LiveConfig.instance.appVersion = config.appVersion;
+      LiveConfig.instance.platform = config.platform;
+    }
+  }
+
+  public static setProviderGetValueMethod(provider2Method: {
+    [provider: string]: (key: string) => Value;
+  }) {
+    if (!LiveConfig.instance) {
+      throw new Error("LiveConfig instance is not initialized. Call init() first.");
+    }
+    if (!LiveConfig.instance.providerGetvalueMethod) {
+      LiveConfig.instance.providerGetvalueMethod = {};
+    }
+    LiveConfig.instance.providerGetvalueMethod = {
+      ...LiveConfig.instance.providerGetvalueMethod,
+      ...provider2Method,
+    };
+  }
+
+  public static getInstance(): LiveConfig {
+    if (!LiveConfig.instance) {
+      throw new Error("LiveConfig instance is not initialized. Call init() first.");
+    }
+    return LiveConfig.instance;
+  }
+}