@applicaster/zapp-react-native-utils 16.0.0-rc.123 → 16.0.0-rc.125

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/configurationUtils/__tests__/modalBlocksParser.test.ts

@@ -171,6 +171,17 @@ describe("parseModalBlocksConfiguration", () => {
     expect(result.item.checkbox.default).toBeUndefined();
     expect(result.item.actionButtons.default).toBeUndefined();
   });
+
+  it("parses the generic button leading icon asset", () => {
+    const result = parseModalBlocksConfiguration(
+      { "button.leading_icon.asset": "https://example.com/add.png" },
+      "playlist-experience"
+    );
+
+    expect(result.button.leadingIcon.default?.asset).toBe(
+      "https://example.com/add.png"
+    );
+  });
 });
 
 describe("getEmptyModalBlocksStructure", () => {

package/modalState/ModalOrchestrator.ts

@@ -45,6 +45,7 @@ function menuToModalArgs(
       summary: menu.header?.subtitle,
       styleOverrides: menu.content.styleOverrides,
       emptyMessage: menu.content.emptyMessage,
+      operationButtons: menu.content.operationButtons,
       onPress: onItemPress,
       viewModel,
     },

package/modalState/__tests__/ModalOrchestrator.phase3.test.ts

@@ -60,4 +60,27 @@ describe("ModalOrchestrator phase 3", () => {
 
     expect(props.emptyMessage).toBe("Queued items will be added here");
   });
+
+  it("forwards operationButtons onto the sheet props unchanged", () => {
+    const operationButtons = {
+      add: {
+        title: "Create New Playlist",
+        iconURL: "https://example.com/add.png",
+      },
+    };
+
+    modalOrchestrator.open({
+      header: { title: "Playlists" },
+      content: {
+        title: "Playlists",
+        items: [],
+        operationButtons,
+      },
+    });
+
+    const props = (modalStore.getState().modalState.screen as any)
+      ?.modalBottomSheetContentProps;
+
+    expect(props.operationButtons).toEqual(operationButtons);
+  });
 });

package/modalState/index.ts

@@ -23,6 +23,8 @@ export type {
   SecondaryAction,
   SelectMode,
   SelectionBehavior,
+  OperationButton,
+  OperationButtons,
 } from "./types";
 
 export {

package/modalState/types.ts

@@ -1,3 +1,5 @@
+import type { EntryAction } from "../entryActions/types";
+
 export interface Header {
   title: string;
   subtitle?: string;
@@ -107,6 +109,13 @@ export interface DynamicCollectionOptions {
   events?: Record<CollectionScopedOperation | string, Action[]>;
 }
 
+/** Presentation of a sheet-synthesized operation control; same fields as an entry action button. */
+export type OperationButton = Pick<EntryAction["button"], "title" | "iconURL">;
+
+export type OperationButtons = Partial<
+  Record<CollectionScopedOperation | string, OperationButton>
+>;
+
 export interface Content {
   title: string;
   stickyTitle?: boolean;
@@ -120,6 +129,8 @@ export interface Content {
   styleOverrides?: Record<string, any>;
   /** Shown under Next Up when the queue sheet has no upcoming items. */
   emptyMessage?: string;
+  /** Producer-owned presentation for sheet-synthesized operation controls (e.g. `add`). */
+  operationButtons?: OperationButtons;
   context?: Record<string, any>;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applicaster/zapp-react-native-utils",
-  "version": "16.0.0-rc.123",
+  "version": "16.0.0-rc.125",
   "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.123",
+    "@applicaster/applicaster-types": "16.0.0-rc.125",
     "buffer": "^5.2.1",
     "camelize": "^1.0.0",
     "dayjs": "^1.11.10",

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