@applicaster/zapp-react-native-utils 16.0.0-rc.122 → 16.0.0-rc.124

package/appUtils/contextKeysManager/index.ts

@@ -1,6 +1,6 @@
 import { isNil } from "@applicaster/zapp-react-native-utils/utils";
 
-import { StorageLevel, StorageType } from "./consts";
+import { StorageLevel } from "./consts";
 import {
   getNamespaceAndKey,
   keyIsValid,
@@ -59,18 +59,14 @@ type Setup = {
   sessionStorage?: Storage;
   localStorage?: Storage;
   secureStorage?: Storage;
-  referenceStorage?: Storage;
 };
 
-export const REFERENCE_NAMESPACE = "applicaster.v2.references";
-
 export class ContextKeysManager {
   private static _instance: ContextKeysManager;
   private _logger: Logger;
   private _sessionStorage: Storage;
   private _localStorage: Storage;
   private _secureStorage: Storage;
-  private _referenceStorage: Storage;
 
   public static get instance() {
     if (!this._instance) {
@@ -79,7 +75,6 @@ export class ContextKeysManager {
         sessionStorage: SessionStorage,
         localStorage: LocalStorage,
         secureStorage: SecureStorage,
-        referenceStorage: SessionStorage,
       });
 
       this._instance = instance;
@@ -94,13 +89,11 @@ export class ContextKeysManager {
     sessionStorage = SessionStorage,
     localStorage = LocalStorage,
     secureStorage = SecureStorage,
-    referenceStorage = SessionStorage,
-  }: Setup) {
+  }: Setup = {}) {
     this._logger = logger;
     this._sessionStorage = sessionStorage;
     this._localStorage = localStorage;
     this._secureStorage = secureStorage;
-    this._referenceStorage = referenceStorage;
   }
 
   private parseKey(key: KeyName): ParsedKeyAndNamespace {
@@ -119,41 +112,6 @@ export class ContextKeysManager {
     return { isValid: true, ...parsedKey };
   }
 
-  // GET
-  public async getKeyByReference(
-    key: string,
-    namespace: string
-  ): Promise<ValueOrNothing> {
-    // 1) look for storage
-    // 2) if storage found - look value in it
-    // 3) if storage not found return NOTHING
-
-    return this._referenceStorage
-      .getItem(buildNamespaceKey(key, namespace), REFERENCE_NAMESPACE)
-      .then((storage: StorageType | unknown) => {
-        switch (storage) {
-          case StorageType.session:
-            return this._sessionStorage.getItem(key, namespace);
-          case StorageType.local:
-            return this._localStorage.getItem(key, namespace);
-          case StorageType.secure:
-            return this._secureStorage.getItem(key, namespace);
-          default:
-            // unknown storage
-            return NOTHING;
-        }
-      })
-      .catch((error) => {
-        // something went wrong
-        this._logger.warn({
-          message: error.message,
-          data: { key, namespace },
-        });
-
-        return NOTHING;
-      });
-  }
-
   public async getKeys(
     keys: Array<KeyName>,
     contextObj?: { key: string; required?: boolean }[]
@@ -228,19 +186,7 @@ export class ContextKeysManager {
       return NOTHING;
     }
 
-    // at first - try to find by reference
-    // if not found, look in session > local > secure
-
-    const resultByReference = await this.getKeyByReference(
-      parsedKey,
-      parsedNamespace
-    );
-
-    if (!isNil(resultByReference)) {
-      return resultByReference;
-    }
-
-    // try to full-search
+    // look in session > local > secure
     try {
       const resultFromSessionStorage = await this._sessionStorage.getItem(
         parsedKey,
@@ -284,41 +230,6 @@ export class ContextKeysManager {
   // GET
 
   // SET
-  public async setReferenceForKey(
-    key: string,
-    namespace: string,
-    storageLevel: StorageLevel
-  ): Promise<boolean> {
-    return this._referenceStorage
-      .setItem(
-        buildNamespaceKey(key, namespace),
-        storageLevel,
-        REFERENCE_NAMESPACE
-      )
-      .then((result) => {
-        if (savingResultIsSuccess(result)) {
-          return true;
-        }
-
-        this._logger.warn({
-          message:
-            "While saving reference - reference storage return non expected value: true",
-          data: { key, namespace, storageLevel },
-        });
-
-        return false;
-      })
-      .catch((error) => {
-        // something went wrong
-        this._logger.warn({
-          message: error.message,
-          data: { key, namespace, storageLevel },
-        });
-
-        return false;
-      });
-  }
-
   // for all keys where saving were succeed return true
   // for others return false
   public async setKeys(
@@ -352,29 +263,36 @@ export class ContextKeysManager {
     }
 
     try {
+      let setItemResult: boolean;
+
       switch (storageLevel) {
         case StorageLevel.persisted:
-          return await Promise.all([
-            this._localStorage.setItem(parsedKey, value, parsedNamespace),
-            this.setReferenceForKey(parsedKey, parsedNamespace, storageLevel),
-          ]).then(([setItemResult]) => {
-            return savingResultIsSuccess(setItemResult);
-          });
+          setItemResult = await this._localStorage.setItem(
+            parsedKey,
+            value,
+            parsedNamespace
+          );
+
+          break;
         case StorageLevel.secure:
-          return await Promise.all([
-            this._secureStorage.setItem(parsedKey, value, parsedNamespace),
-            this.setReferenceForKey(parsedKey, parsedNamespace, storageLevel),
-          ]).then(([setItemResult]) => {
-            return savingResultIsSuccess(setItemResult);
-          });
+          setItemResult = await this._secureStorage.setItem(
+            parsedKey,
+            value,
+            parsedNamespace
+          );
+
+          break;
         default:
-          return await Promise.all([
-            this._sessionStorage.setItem(parsedKey, value, parsedNamespace),
-            this.setReferenceForKey(parsedKey, parsedNamespace, storageLevel),
-          ]).then(([setItemResult]) => {
-            return savingResultIsSuccess(setItemResult);
-          });
+          setItemResult = await this._sessionStorage.setItem(
+            parsedKey,
+            value,
+            parsedNamespace
+          );
+
+          break;
       }
+
+      return savingResultIsSuccess(setItemResult);
     } catch (error) {
       // something went wrong
       this._logger.warn({
@@ -388,24 +306,6 @@ export class ContextKeysManager {
   // SET
 
   // REMOVE
-  public async removeReferenceForKey(
-    key: string,
-    namespace: string
-  ): Promise<boolean> {
-    return this._referenceStorage
-      .removeItem(buildNamespaceKey(key, namespace), REFERENCE_NAMESPACE)
-      .then(() => true)
-      .catch((error) => {
-        // something went wrong
-        this._logger.warn({
-          message: error.message,
-          data: { key, namespace },
-        });
-
-        return false;
-      });
-  }
-
   public async removeKey(key: KeyName): Promise<boolean> {
     const {
       isValid: isValidKey,
@@ -422,7 +322,6 @@ export class ContextKeysManager {
       this._sessionStorage.removeItem(parsedKey, parsedNamespace),
       this._localStorage.removeItem(parsedKey, parsedNamespace),
       this._secureStorage.removeItem(parsedKey, parsedNamespace),
-      this.removeReferenceForKey(parsedKey, parsedNamespace),
     ])
       .then(() => true)
       .catch((error) => {

package/manifestUtils/keys.js

@@ -484,7 +484,7 @@ const MOBILE_ACTION_BUTTON_FIELDS = [
       { text: "share", value: "native_share_action" },
       { text: "downloads", value: "offline-content-button" },
       { text: "trailer", value: "trailer_action" },
-      { text: "mute/unmute", value: "mute_unmute" },
+      { text: "mute/unmute", value: "mute_unmute_action" },
     ],
   },
   {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applicaster/zapp-react-native-utils",
-  "version": "16.0.0-rc.122",
+  "version": "16.0.0-rc.124",
   "description": "Applicaster Zapp React Native utilities package",
   "main": "index.js",
   "types": "index.d.ts",
@@ -27,7 +27,7 @@
   },
   "homepage": "https://github.com/applicaster/quickbrick#readme",
   "dependencies": {
-    "@applicaster/applicaster-types": "16.0.0-rc.122",
+    "@applicaster/applicaster-types": "16.0.0-rc.124",
     "buffer": "^5.2.1",
     "camelize": "^1.0.0",
     "dayjs": "^1.11.10",
@@ -36,6 +36,7 @@
     "prop-types": "^15.0.0"
   },
   "peerDependencies": {
+    "@applicaster/quick-brick-assets": "*",
     "@applicaster/zapp-pipes-v2-client": "*",
     "@react-native-community/netinfo": "*",
     "react": "*",

package/quickBrickAssets/__tests__/index.test.ts

@@ -0,0 +1,18 @@
+// The Jest stand-in for @applicaster/quick-brick-assets maps each existing key to itself
+import { getQuickBrickAsset } from "..";
+
+describe("getQuickBrickAsset", () => {
+  it("returns the asset for a plugin identifier and path", () => {
+    expect(
+      getQuickBrickAsset("mute_unmute_action", "action/flavour_1/mute.png")
+    ).toBe("mute_unmute_action/action/flavour_1/mute.png");
+  });
+
+  it("rejects unknown paths and plugin identifiers at compile time", () => {
+    // @ts-expect-error - no such file in mute_unmute_action
+    getQuickBrickAsset("mute_unmute_action", "action/flavour_9/mute.png");
+
+    // @ts-expect-error - no assets folder for this plugin
+    getQuickBrickAsset("unknown_plugin", "action/flavour_1/mute.png");
+  });
+});

package/quickBrickAssets/index.ts

@@ -0,0 +1,35 @@
+import assets from "@applicaster/quick-brick-assets";
+import type {
+  QuickBrickAssetKey,
+  QuickBrickAssetSource,
+} from "@applicaster/quick-brick-assets";
+
+export type { QuickBrickAssetKey, QuickBrickAssetSource };
+
+type PluginOf<K> = K extends `${infer Plugin}/${string}` ? Plugin : never;
+
+type PathOf<K, Plugin extends string> = K extends `${Plugin}/${infer Path}`
+  ? Path
+  : never;
+
+/** Plugin identifiers that have a folder in `@applicaster/quick-brick-assets`. */
+export type QuickBrickAssetPlugin = PluginOf<QuickBrickAssetKey>;
+
+/** Asset paths inside the given plugin's folder. */
+export type QuickBrickAssetPath<Plugin extends QuickBrickAssetPlugin> = PathOf<
+  QuickBrickAssetKey,
+  Plugin
+>;
+
+/**
+ * Looks up an asset of `@applicaster/quick-brick-assets` by plugin identifier
+ * and path relative to the plugin folder, e.g.
+ * `getQuickBrickAsset("mute_unmute_action", "action/flavour_1/mute.png")`.
+ * Both arguments are checked against the package's files at compile time.
+ * Density variants (`@2x` / `@3x`) are not supported.
+ */
+export const getQuickBrickAsset = <Plugin extends QuickBrickAssetPlugin>(
+  pluginIdentifier: Plugin,
+  assetPath: QuickBrickAssetPath<Plugin>
+): QuickBrickAssetSource =>
+  assets[`${pluginIdentifier}/${assetPath}` as QuickBrickAssetKey];

package/reactHooks/actions/index.ts

@@ -21,17 +21,45 @@ type ActionContexts<T = unknown> = {
 };
 
 /**
- * React Hook to subscribe to the custom action context
+ * A value that changes whenever a provider is added to or removed from
+ * `uiActionsRegistry`.
+ *
+ * Providers can register after the UI that wants them has rendered - the audio
+ * player registers playback speed only once its controller has state, and
+ * plugin-backed actions are bridged in from an effect. Put this in the
+ * dependency list of anything that resolves actions, so the list is re-read
+ * instead of being frozen at first paint.
+ */
+export function useRegistryRevision(): number {
+  const [revision, setRevision] = useState(0);
+
+  useEffect(
+    () =>
+      uiActionsRegistry.subscribe(() => setRevision((current) => current + 1)),
+    []
+  );
+
+  return revision;
+}
+
+/**
+ * Resolves a legacy action context or falls back to the UI action registry.
  * @param {*} plugId - subscribes to the context of that action plugin
  * @return {*} - global action provider context or context for specific action plugin
  */
 export function useActions<T = unknown>(plugId: string): any {
   const [logged, setLogged] = useState(false);
   const context = useContext<ActionContexts<T>>(ActionsContext);
+  useRegistryRevision();
+
   const actionContext = context?.actions?.[plugId]?.module?.context;
 
   if (plugId) {
     if (!actionContext) {
+      const registeredAction = uiActionsRegistry.getAction(plugId);
+
+      if (registeredAction) return registeredAction;
+
       if (!logged) {
         logger.warning({
           message: `useActions: Couldn't find an action for ${plugId} plugin`,
@@ -139,25 +167,3 @@ export function useEntryActionState(
 
   return { state, invokeAction };
 }
-
-/**
- * A value that changes whenever a provider is added to or removed from
- * `uiActionsRegistry`.
- *
- * Providers can register after the UI that wants them has rendered - the audio
- * player registers playback speed only once its controller has state, and
- * plugin-backed actions are bridged in from an effect. Put this in the
- * dependency list of anything that resolves actions, so the list is re-read
- * instead of being frozen at first paint.
- */
-export function useRegistryRevision(): number {
-  const [revision, setRevision] = useState(0);
-
-  useEffect(
-    () =>
-      uiActionsRegistry.subscribe(() => setRevision((current) => current + 1)),
-    []
-  );
-
-  return revision;
-}

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();
-  });
-});