@applicaster/zapp-react-native-utils 16.0.0-alpha.2663208063 → 16.0.0-alpha.2710214351

package/uiActionsRegistrator/usableActionItems.ts

@@ -0,0 +1,66 @@
+import { createLogger } from "../logger";
+
+import { RegisteredAction } from "./registry";
+
+const { log_warning } = createLogger({
+  subsystem: "UIActionsRegistry",
+  category: "ActionRegistration",
+});
+
+/**
+ * Identifiers already reported as unusable. This runs on every render of the
+ * player overlay, so the warning is emitted once per identifier and forgotten
+ * again as soon as that action becomes invokable.
+ */
+const reportedUnusable = new Set<string>();
+
+function isInvokableAction(
+  item: RegisteredAction | undefined
+): item is RegisteredAction {
+  return typeof item?.action?.invokeAction === "function";
+}
+
+/**
+ * Narrows a resolved action list to what can actually be shown and invoked:
+ * anything without a usable `invokeAction` is dropped, and a repeated
+ * identifier keeps only its first occurrence. Order is preserved.
+ *
+ * Both the player overflow and the bottom sheet plugin build their list this
+ * way, and the player resolver applies it to `player_action_buttons` too - a
+ * hand-typed config string can name the same action twice.
+ */
+export function usableActionItems(
+  items: RegisteredAction[]
+): RegisteredAction[] {
+  const seen = new Set<string>();
+  const result: RegisteredAction[] = [];
+
+  for (const item of items ?? []) {
+    const identifier = item?.identifier;
+
+    // A duplicate is expected - a config string may name the same action twice
+    // - and an action with no identifier cannot be named in a log anyway.
+    if (!identifier || seen.has(identifier)) {
+      continue;
+    }
+
+    if (!isInvokableAction(item)) {
+      if (!reportedUnusable.has(identifier)) {
+        reportedUnusable.add(identifier);
+
+        log_warning(
+          `usableActionItems: dropping action "${identifier}" - its provider returned no invokeAction, so it cannot be shown`,
+          { identifier }
+        );
+      }
+
+      continue;
+    }
+
+    reportedUnusable.delete(identifier);
+    seen.add(identifier);
+    result.push(item);
+  }
+
+  return result;
+}

package/appUtils/contextKeysManager/__tests__/getKey/success/byReference.test.ts

@@ -1,56 +0,0 @@
-import { ContextKeysManager } from "../../..";
-
-describe("Context Keys Manager - getKey", () => {
-  it("returns value if found by reference", async () => {
-    // setup
-    const key = "namespace.key";
-    const value = "value";
-
-    const mockedLogger = {
-      warn: jest.fn(),
-    };
-
-    const mockedSessionStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedLocalStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedSecureStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const contextManager = new ContextKeysManager({
-      logger: mockedLogger,
-      sessionStorage: mockedSessionStorage,
-      localStorage: mockedLocalStorage,
-      secureStorage: mockedSecureStorage,
-    });
-
-    const getKeyByReference = jest
-      .spyOn(contextManager, "getKeyByReference")
-      .mockResolvedValueOnce(value);
-
-    // run
-    const result = await contextManager.getKey(key);
-
-    // verify
-    expect(result).toEqual(value);
-
-    expect(mockedLogger.warn).not.toHaveBeenCalled();
-
-    expect(getKeyByReference).toHaveBeenCalledWith("key", "namespace");
-
-    expect(mockedSessionStorage.getItem).not.toHaveBeenCalled();
-    expect(mockedLocalStorage.getItem).not.toHaveBeenCalled();
-    expect(mockedSecureStorage.getItem).not.toHaveBeenCalled();
-  });
-});

package/appUtils/contextKeysManager/__tests__/getKeyByReference/failure.test.ts

@@ -1,265 +0,0 @@
-import { ContextKeysManager, REFERENCE_NAMESPACE, NOTHING } from "../..";
-import { buildNamespaceKey } from "../../utils";
-import { StorageType } from "../../consts";
-
-describe("Context Keys Manager - getKeyByReference", () => {
-  it("returns null if reference-storage failed", async () => {
-    // setup
-    const key = "key";
-    const namespace = "namespace";
-    const error = Error("oops");
-
-    const mockedLogger = {
-      warn: jest.fn(),
-    };
-
-    const mockedSessionStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedLocalStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedSecureStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedReferenceStorage = {
-      getItem: jest.fn().mockRejectedValueOnce(error),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const contextManager = new ContextKeysManager({
-      logger: mockedLogger,
-      sessionStorage: mockedSessionStorage,
-      localStorage: mockedLocalStorage,
-      secureStorage: mockedSecureStorage,
-      referenceStorage: mockedReferenceStorage,
-    });
-
-    // run
-    const result = await contextManager.getKeyByReference(key, namespace);
-
-    // verify
-    expect(result).toEqual(NOTHING);
-
-    expect(mockedLogger.warn).toHaveBeenCalledTimes(1);
-
-    expect(mockedLogger.warn).toHaveBeenCalledWith({
-      message: error.message,
-      data: { key, namespace },
-    });
-
-    expect(mockedSessionStorage.getItem).not.toHaveBeenCalled();
-    expect(mockedLocalStorage.getItem).not.toHaveBeenCalled();
-    expect(mockedSecureStorage.getItem).not.toHaveBeenCalled();
-
-    expect(mockedReferenceStorage.getItem).toHaveBeenCalledWith(
-      buildNamespaceKey(key, namespace),
-      REFERENCE_NAMESPACE
-    );
-  });
-
-  it("returns null if from session-storage failed", async () => {
-    // setup
-    const key = "key";
-    const namespace = "namespace";
-    const error = Error("oops");
-
-    const mockedLogger = {
-      warn: jest.fn(),
-    };
-
-    const mockedSessionStorage = {
-      getItem: jest.fn().mockRejectedValueOnce(error),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedLocalStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedSecureStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedReferenceStorage = {
-      getItem: jest.fn().mockResolvedValueOnce(StorageType.session),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const contextManager = new ContextKeysManager({
-      logger: mockedLogger,
-      sessionStorage: mockedSessionStorage,
-      localStorage: mockedLocalStorage,
-      secureStorage: mockedSecureStorage,
-      referenceStorage: mockedReferenceStorage,
-    });
-
-    // run
-    const result = await contextManager.getKeyByReference(key, namespace);
-
-    // verify
-    expect(result).toEqual(NOTHING);
-
-    expect(mockedLogger.warn).toHaveBeenCalledTimes(1);
-
-    expect(mockedLogger.warn).toHaveBeenCalledWith({
-      message: error.message,
-      data: { key, namespace },
-    });
-
-    expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(key, namespace);
-    expect(mockedLocalStorage.getItem).not.toHaveBeenCalled();
-    expect(mockedSecureStorage.getItem).not.toHaveBeenCalled();
-
-    expect(mockedReferenceStorage.getItem).toHaveBeenCalledWith(
-      buildNamespaceKey(key, namespace),
-      REFERENCE_NAMESPACE
-    );
-  });
-
-  it("returns null if from local-storage failed", async () => {
-    // setup
-    const key = "key";
-    const namespace = "namespace";
-    const error = Error("oops");
-
-    const mockedLogger = {
-      warn: jest.fn(),
-    };
-
-    const mockedSessionStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedLocalStorage = {
-      getItem: jest.fn().mockRejectedValueOnce(error),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedSecureStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedReferenceStorage = {
-      getItem: jest.fn().mockResolvedValueOnce(StorageType.local),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const contextManager = new ContextKeysManager({
-      logger: mockedLogger,
-      sessionStorage: mockedSessionStorage,
-      localStorage: mockedLocalStorage,
-      secureStorage: mockedSecureStorage,
-      referenceStorage: mockedReferenceStorage,
-    });
-
-    // run
-    const result = await contextManager.getKeyByReference(key, namespace);
-
-    // verify
-    expect(result).toEqual(NOTHING);
-
-    expect(mockedLogger.warn).toHaveBeenCalledTimes(1);
-
-    expect(mockedLogger.warn).toHaveBeenCalledWith({
-      message: error.message,
-      data: { key, namespace },
-    });
-
-    expect(mockedSessionStorage.getItem).not.toHaveBeenCalled();
-    expect(mockedLocalStorage.getItem).toHaveBeenCalledWith(key, namespace);
-    expect(mockedSecureStorage.getItem).not.toHaveBeenCalled();
-
-    expect(mockedReferenceStorage.getItem).toHaveBeenCalledWith(
-      buildNamespaceKey(key, namespace),
-      REFERENCE_NAMESPACE
-    );
-  });
-
-  it("returns null if from secure-storage failed", async () => {
-    // setup
-    const key = "key";
-    const namespace = "namespace";
-    const error = Error("oops");
-
-    const mockedLogger = {
-      warn: jest.fn(),
-    };
-
-    const mockedSessionStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedLocalStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedSecureStorage = {
-      getItem: jest.fn().mockRejectedValueOnce(error),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedReferenceStorage = {
-      getItem: jest.fn().mockResolvedValueOnce(StorageType.secure),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const contextManager = new ContextKeysManager({
-      logger: mockedLogger,
-      sessionStorage: mockedSessionStorage,
-      localStorage: mockedLocalStorage,
-      secureStorage: mockedSecureStorage,
-      referenceStorage: mockedReferenceStorage,
-    });
-
-    // run
-    const result = await contextManager.getKeyByReference(key, namespace);
-
-    // verify
-    expect(result).toEqual(NOTHING);
-
-    expect(mockedLogger.warn).toHaveBeenCalledTimes(1);
-
-    expect(mockedLogger.warn).toHaveBeenCalledWith({
-      message: error.message,
-      data: { key, namespace },
-    });
-
-    expect(mockedSessionStorage.getItem).not.toHaveBeenCalled();
-    expect(mockedLocalStorage.getItem).not.toHaveBeenCalled();
-    expect(mockedSecureStorage.getItem).toHaveBeenCalledWith(key, namespace);
-
-    expect(mockedReferenceStorage.getItem).toHaveBeenCalledWith(
-      buildNamespaceKey(key, namespace),
-      REFERENCE_NAMESPACE
-    );
-  });
-});

package/appUtils/contextKeysManager/__tests__/getKeyByReference/success.test.ts

@@ -1,303 +0,0 @@
-import { ContextKeysManager, REFERENCE_NAMESPACE, NOTHING } from "../..";
-import { buildNamespaceKey } from "../../utils";
-import { StorageType } from "../../consts";
-
-describe("Context Keys Manager - getKeyByReference", () => {
-  it("returns null if storage is not found", async () => {
-    // setup
-    const key = "key";
-    const namespace = "namespace";
-
-    const mockedLogger = {
-      warn: jest.fn(),
-    };
-
-    const mockedSessionStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedLocalStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedSecureStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedReferenceStorage = {
-      getItem: jest.fn().mockResolvedValueOnce(undefined),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const contextManager = new ContextKeysManager({
-      logger: mockedLogger,
-      sessionStorage: mockedSessionStorage,
-      localStorage: mockedLocalStorage,
-      secureStorage: mockedSecureStorage,
-      referenceStorage: mockedReferenceStorage,
-    });
-
-    // run
-    const result = await contextManager.getKeyByReference(key, namespace);
-
-    // verify
-    expect(result).toEqual(NOTHING);
-
-    expect(mockedLogger.warn).not.toHaveBeenCalled();
-
-    expect(mockedSessionStorage.getItem).not.toHaveBeenCalled();
-    expect(mockedLocalStorage.getItem).not.toHaveBeenCalled();
-    expect(mockedSecureStorage.getItem).not.toHaveBeenCalled();
-
-    expect(mockedReferenceStorage.getItem).toHaveBeenCalledWith(
-      buildNamespaceKey(key, namespace),
-      REFERENCE_NAMESPACE
-    );
-  });
-
-  it("returns null if storage is unknown", async () => {
-    // setup
-    const key = "key";
-    const namespace = "namespace";
-
-    const mockedLogger = {
-      warn: jest.fn(),
-    };
-
-    const mockedSessionStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedLocalStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedSecureStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedReferenceStorage = {
-      getItem: jest.fn().mockResolvedValueOnce("unknown"),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const contextManager = new ContextKeysManager({
-      logger: mockedLogger,
-      sessionStorage: mockedSessionStorage,
-      localStorage: mockedLocalStorage,
-      secureStorage: mockedSecureStorage,
-      referenceStorage: mockedReferenceStorage,
-    });
-
-    // run
-    const result = await contextManager.getKeyByReference(key, namespace);
-
-    // verify
-    expect(result).toEqual(NOTHING);
-
-    expect(mockedLogger.warn).not.toHaveBeenCalled();
-
-    expect(mockedSessionStorage.getItem).not.toHaveBeenCalled();
-    expect(mockedLocalStorage.getItem).not.toHaveBeenCalled();
-    expect(mockedSecureStorage.getItem).not.toHaveBeenCalled();
-
-    expect(mockedReferenceStorage.getItem).toHaveBeenCalledWith(
-      buildNamespaceKey(key, namespace),
-      REFERENCE_NAMESPACE
-    );
-  });
-
-  it("returns value from session storage", async () => {
-    // setup
-    const key = "key";
-    const namespace = "namespace";
-    const value = "value";
-
-    const mockedLogger = {
-      warn: jest.fn(),
-    };
-
-    const mockedSessionStorage = {
-      getItem: jest.fn().mockResolvedValueOnce(value),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedLocalStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedSecureStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedReferenceStorage = {
-      getItem: jest.fn().mockResolvedValueOnce(StorageType.session),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const contextManager = new ContextKeysManager({
-      logger: mockedLogger,
-      sessionStorage: mockedSessionStorage,
-      localStorage: mockedLocalStorage,
-      secureStorage: mockedSecureStorage,
-      referenceStorage: mockedReferenceStorage,
-    });
-
-    // run
-    const result = await contextManager.getKeyByReference(key, namespace);
-
-    // verify
-    expect(result).toEqual(value);
-
-    expect(mockedLogger.warn).not.toHaveBeenCalled();
-
-    expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(key, namespace);
-    expect(mockedLocalStorage.getItem).not.toHaveBeenCalled();
-    expect(mockedSecureStorage.getItem).not.toHaveBeenCalled();
-
-    expect(mockedReferenceStorage.getItem).toHaveBeenCalledWith(
-      buildNamespaceKey(key, namespace),
-      REFERENCE_NAMESPACE
-    );
-  });
-
-  it("returns value from local storage", async () => {
-    // setup
-    const key = "key";
-    const namespace = "namespace";
-    const value = "value";
-
-    const mockedLogger = {
-      warn: jest.fn(),
-    };
-
-    const mockedSessionStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedLocalStorage = {
-      getItem: jest.fn().mockResolvedValueOnce(value),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedSecureStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedReferenceStorage = {
-      getItem: jest.fn().mockResolvedValueOnce(StorageType.local),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const contextManager = new ContextKeysManager({
-      logger: mockedLogger,
-      sessionStorage: mockedSessionStorage,
-      localStorage: mockedLocalStorage,
-      secureStorage: mockedSecureStorage,
-      referenceStorage: mockedReferenceStorage,
-    });
-
-    // run
-    const result = await contextManager.getKeyByReference(key, namespace);
-
-    // verify
-    expect(result).toEqual(value);
-
-    expect(mockedLogger.warn).not.toHaveBeenCalled();
-
-    expect(mockedSessionStorage.getItem).not.toHaveBeenCalled();
-    expect(mockedLocalStorage.getItem).toHaveBeenCalledWith(key, namespace);
-    expect(mockedSecureStorage.getItem).not.toHaveBeenCalled();
-
-    expect(mockedReferenceStorage.getItem).toHaveBeenCalledWith(
-      buildNamespaceKey(key, namespace),
-      REFERENCE_NAMESPACE
-    );
-  });
-
-  it("returns value from secure storage", async () => {
-    // setup
-    const key = "key";
-    const namespace = "namespace";
-    const value = "value";
-
-    const mockedLogger = {
-      warn: jest.fn(),
-    };
-
-    const mockedSessionStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedLocalStorage = {
-      getItem: jest.fn(),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedSecureStorage = {
-      getItem: jest.fn().mockResolvedValueOnce(value),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const mockedReferenceStorage = {
-      getItem: jest.fn().mockResolvedValueOnce(StorageType.secure),
-      setItem: jest.fn(),
-      removeItem: jest.fn(),
-    };
-
-    const contextManager = new ContextKeysManager({
-      logger: mockedLogger,
-      sessionStorage: mockedSessionStorage,
-      localStorage: mockedLocalStorage,
-      secureStorage: mockedSecureStorage,
-      referenceStorage: mockedReferenceStorage,
-    });
-
-    // run
-    const result = await contextManager.getKeyByReference(key, namespace);
-
-    // verify
-    expect(result).toEqual(value);
-
-    expect(mockedLogger.warn).not.toHaveBeenCalled();
-
-    expect(mockedSessionStorage.getItem).not.toHaveBeenCalled();
-    expect(mockedLocalStorage.getItem).not.toHaveBeenCalled();
-    expect(mockedSecureStorage.getItem).toHaveBeenCalledWith(key, namespace);
-
-    expect(mockedReferenceStorage.getItem).toHaveBeenCalledWith(
-      buildNamespaceKey(key, namespace),
-      REFERENCE_NAMESPACE
-    );
-  });
-});