@applicaster/zapp-react-native-utils 15.1.22-rc.0 → 15.1.23-alpha.1501426102
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/actionsExecutor/__tests__/StorageActions.test.ts +98 -0
- package/actionsExecutor/__tests__/feedDecorator.test.ts +30 -0
- package/actionsExecutor/__tests__/screenToggleFlag.test.ts +90 -0
- package/actionsExecutor/actions/__tests__/openBottomSheet.inlineItems.test.ts +72 -0
- package/actionsExecutor/actions/openBottomSheet.ts +1 -0
- package/actionsExecutor/actions/screenToggleFlag.ts +1 -3
- package/actionsExecutor/feedDecorator.ts +6 -0
- package/configurationUtils/__tests__/modalBlocksParser.test.ts +46 -34
- package/configurationUtils/modalBlocksParser.ts +10 -106
- package/entryActions/__tests__/buildEntryActions.test.ts +58 -18
- package/entryActions/aliasPresentation.ts +26 -42
- package/entryActions/index.ts +0 -2
- package/modalState/ModalOrchestrator.ts +1 -0
- package/modalState/__tests__/ModalOrchestrator.phase3.test.ts +23 -0
- package/modalState/index.ts +2 -0
- package/modalState/types.ts +11 -0
- package/package.json +2 -2
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import { ActionResult } from "../ActionExecutor";
|
|
2
|
+
import { localStorageToggleFlag } from "../StorageActions";
|
|
3
|
+
import { TOGGLE_FLAG_MAX_ITEMS_REACHED_EVENT } from "../consts";
|
|
4
|
+
import { postEvent } from "../../reactHooks/useSubscriberFor";
|
|
5
|
+
|
|
6
|
+
jest.mock("../ActionExecutorContext", () => ({
|
|
7
|
+
log_error: jest.fn(),
|
|
8
|
+
log_info: jest.fn(),
|
|
9
|
+
}));
|
|
10
|
+
|
|
11
|
+
jest.mock("../../reactHooks/useSubscriberFor", () => ({
|
|
12
|
+
postEvent: jest.fn(),
|
|
13
|
+
}));
|
|
14
|
+
|
|
15
|
+
// In-memory stand-in for the storage-backed provider; the limit check under
|
|
16
|
+
// test lives in storageToggleFlag, not in the provider.
|
|
17
|
+
const mockStore: Record<string, string[]> = {};
|
|
18
|
+
|
|
19
|
+
jest.mock("../../storage/StorageMultiSelectProvider", () => ({
|
|
20
|
+
StorageMultiSelectProvider: {
|
|
21
|
+
getProvider: (keyNamespace: string) => ({
|
|
22
|
+
getSelectedAsync: async () => [...(mockStore[keyNamespace] ?? [])],
|
|
23
|
+
addItem: async (item: string) => {
|
|
24
|
+
mockStore[keyNamespace] = [...(mockStore[keyNamespace] ?? []), item];
|
|
25
|
+
},
|
|
26
|
+
removeItem: async (item: string) => {
|
|
27
|
+
mockStore[keyNamespace] = (mockStore[keyNamespace] ?? []).filter(
|
|
28
|
+
(it) => it !== item
|
|
29
|
+
);
|
|
30
|
+
},
|
|
31
|
+
}),
|
|
32
|
+
},
|
|
33
|
+
}));
|
|
34
|
+
|
|
35
|
+
const KEY = "user_preferences.teams";
|
|
36
|
+
|
|
37
|
+
// Entries of a team selection feed with explicit tap actions
|
|
38
|
+
// (localStorageToggleFlag with key and selector).
|
|
39
|
+
const teamEntry = (n: number) =>
|
|
40
|
+
({
|
|
41
|
+
id: `team-${n}`,
|
|
42
|
+
title: `Team ${n}`,
|
|
43
|
+
type: { value: "action" },
|
|
44
|
+
extensions: { tag: `TEAM ${n}` },
|
|
45
|
+
}) as unknown as ZappEntry;
|
|
46
|
+
|
|
47
|
+
const tapAction = (extraOptions = {}) =>
|
|
48
|
+
({
|
|
49
|
+
type: "localStorageToggleFlag",
|
|
50
|
+
options: { key: KEY, selector: "extensions.tag", ...extraOptions },
|
|
51
|
+
}) as unknown as ActionType;
|
|
52
|
+
|
|
53
|
+
const tapTeams = async (count: number, extraOptions = {}) => {
|
|
54
|
+
const results: ActionResult[] = [];
|
|
55
|
+
|
|
56
|
+
for (let n = 1; n <= count; n++) {
|
|
57
|
+
results.push(
|
|
58
|
+
await localStorageToggleFlag(
|
|
59
|
+
{ entry: teamEntry(n) },
|
|
60
|
+
tapAction(extraOptions)
|
|
61
|
+
)
|
|
62
|
+
);
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
return results;
|
|
66
|
+
};
|
|
67
|
+
|
|
68
|
+
describe("localStorageToggleFlag max_items", () => {
|
|
69
|
+
beforeEach(() => {
|
|
70
|
+
delete mockStore[KEY];
|
|
71
|
+
jest.clearAllMocks();
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
it("blocks the 11th team when max_items is in the action options", async () => {
|
|
75
|
+
const results = await tapTeams(11, { max_items: "10" });
|
|
76
|
+
|
|
77
|
+
expect(results.slice(0, 10)).toEqual(Array(10).fill(ActionResult.Success));
|
|
78
|
+
expect(results[10]).toBe(ActionResult.Cancel);
|
|
79
|
+
expect(mockStore[KEY]).toHaveLength(10);
|
|
80
|
+
|
|
81
|
+
expect(postEvent).toHaveBeenCalledWith(
|
|
82
|
+
TOGGLE_FLAG_MAX_ITEMS_REACHED_EVENT,
|
|
83
|
+
[expect.objectContaining({ maxItems: "10", tag: "TEAM 11" })]
|
|
84
|
+
);
|
|
85
|
+
});
|
|
86
|
+
|
|
87
|
+
it("still lets a selected team be removed at the limit", async () => {
|
|
88
|
+
await tapTeams(10, { max_items: "10" });
|
|
89
|
+
|
|
90
|
+
const result = await localStorageToggleFlag(
|
|
91
|
+
{ entry: teamEntry(1) },
|
|
92
|
+
tapAction({ max_items: "10" })
|
|
93
|
+
);
|
|
94
|
+
|
|
95
|
+
expect(result).toBe(ActionResult.Success);
|
|
96
|
+
expect(mockStore[KEY]).toHaveLength(9);
|
|
97
|
+
});
|
|
98
|
+
});
|
|
@@ -59,3 +59,33 @@ describe("decorateFeed", () => {
|
|
|
59
59
|
expect(decorated.entry[0].extensions.tap_actions).toBeUndefined();
|
|
60
60
|
});
|
|
61
61
|
});
|
|
62
|
+
|
|
63
|
+
describe("decorateFeed max_items", () => {
|
|
64
|
+
const toggleAction = (feed: ZappFeed) =>
|
|
65
|
+
decorateFeed(feed).entry[0].extensions.tap_actions.actions[0];
|
|
66
|
+
|
|
67
|
+
it.each([
|
|
68
|
+
["screen", "screenToggleFlag"],
|
|
69
|
+
["session", "sessionStorageToggleFlag"],
|
|
70
|
+
["ctx", "localStorageToggleFlag"],
|
|
71
|
+
])("passes max_items to the %s toggle action", (scope, type) => {
|
|
72
|
+
const feed = preferenceFeed("multi");
|
|
73
|
+
feed.extensions.preference_editor_options.scope = scope;
|
|
74
|
+
feed.extensions.preference_editor_options.max_items = "10";
|
|
75
|
+
|
|
76
|
+
const toggle = toggleAction(feed);
|
|
77
|
+
|
|
78
|
+
expect(toggle.type).toBe(type);
|
|
79
|
+
expect(toggle.options).toEqual({ key: "agree", max_items: 10 });
|
|
80
|
+
});
|
|
81
|
+
|
|
82
|
+
it.each([undefined, 0, "0", "ten", -1])(
|
|
83
|
+
"does not set a limit for max_items %p",
|
|
84
|
+
(maxItems) => {
|
|
85
|
+
const feed = preferenceFeed("multi");
|
|
86
|
+
feed.extensions.preference_editor_options.max_items = maxItems;
|
|
87
|
+
|
|
88
|
+
expect(toggleAction(feed).options).toEqual({ key: "agree" });
|
|
89
|
+
}
|
|
90
|
+
);
|
|
91
|
+
});
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import { ActionExecutor, ActionResult } from "../ActionExecutor";
|
|
2
|
+
import { screenToggleFlagAction } from "../actions/screenToggleFlag";
|
|
3
|
+
|
|
4
|
+
jest.mock("../ActionExecutorContext", () => ({
|
|
5
|
+
log_error: jest.fn(),
|
|
6
|
+
log_info: jest.fn(),
|
|
7
|
+
}));
|
|
8
|
+
|
|
9
|
+
jest.mock("../StorageActions", () => ({
|
|
10
|
+
onMaxTagsReached: jest.fn(),
|
|
11
|
+
}));
|
|
12
|
+
|
|
13
|
+
// not used here, but it pulls the native bridge logger in at import time
|
|
14
|
+
jest.mock("../../storage/ScreenSingleValueProvider", () => ({}));
|
|
15
|
+
|
|
16
|
+
jest.mock("../../logger", () => ({
|
|
17
|
+
createLogger: () => ({
|
|
18
|
+
log_error: jest.fn(),
|
|
19
|
+
log_debug: jest.fn(),
|
|
20
|
+
log_info: jest.fn(),
|
|
21
|
+
}),
|
|
22
|
+
}));
|
|
23
|
+
|
|
24
|
+
const mockSelected: string[] = [];
|
|
25
|
+
|
|
26
|
+
jest.mock("../../storage/ScreenStateMultiSelectProvider", () => ({
|
|
27
|
+
ScreenMultiSelectProvider: {
|
|
28
|
+
getProvider: () => ({
|
|
29
|
+
getSelectedAsync: async () => [...mockSelected],
|
|
30
|
+
addItem: async (item: string) => {
|
|
31
|
+
mockSelected.push(item);
|
|
32
|
+
},
|
|
33
|
+
removeItem: async (item: string) => {
|
|
34
|
+
mockSelected.splice(mockSelected.indexOf(item), 1);
|
|
35
|
+
},
|
|
36
|
+
}),
|
|
37
|
+
},
|
|
38
|
+
}));
|
|
39
|
+
|
|
40
|
+
const toggleAction = (options = {}) =>
|
|
41
|
+
({
|
|
42
|
+
type: "screenToggleFlag",
|
|
43
|
+
options: { key: "teams", selector: "extensions.tag", ...options },
|
|
44
|
+
}) as unknown as ActionType;
|
|
45
|
+
|
|
46
|
+
const context = (tag: string) => ({
|
|
47
|
+
screenRoute: "/screen",
|
|
48
|
+
screenStateStore: {},
|
|
49
|
+
entry: { id: tag, extensions: { tag } },
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
describe("screenToggleFlagAction at the max_items limit", () => {
|
|
53
|
+
beforeEach(() => {
|
|
54
|
+
mockSelected.length = 0;
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
it("returns the cancellation so the chained actions do not run", async () => {
|
|
58
|
+
const afterToggle = jest.fn();
|
|
59
|
+
const executor = new ActionExecutor();
|
|
60
|
+
|
|
61
|
+
executor.registerAction("screenToggleFlag", screenToggleFlagAction);
|
|
62
|
+
|
|
63
|
+
executor.registerAction("sendCloudEvent", async () => {
|
|
64
|
+
afterToggle();
|
|
65
|
+
|
|
66
|
+
return ActionResult.Success;
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
mockSelected.push("A", "B");
|
|
70
|
+
|
|
71
|
+
const result = await executor.handleActions(
|
|
72
|
+
[toggleAction({ max_items: 2 }), { type: "sendCloudEvent" }],
|
|
73
|
+
context("C") as never
|
|
74
|
+
);
|
|
75
|
+
|
|
76
|
+
expect(result).toBe(ActionResult.Cancel);
|
|
77
|
+
expect(afterToggle).not.toHaveBeenCalled();
|
|
78
|
+
expect(mockSelected).toEqual(["A", "B"]);
|
|
79
|
+
});
|
|
80
|
+
|
|
81
|
+
it("lets the chain continue below the limit", async () => {
|
|
82
|
+
const result = await screenToggleFlagAction(
|
|
83
|
+
toggleAction({ max_items: 2 }),
|
|
84
|
+
context("A") as never
|
|
85
|
+
);
|
|
86
|
+
|
|
87
|
+
expect(result).toBe(ActionResult.Success);
|
|
88
|
+
expect(mockSelected).toEqual(["A"]);
|
|
89
|
+
});
|
|
90
|
+
});
|
|
@@ -2,6 +2,22 @@ import { openBottomSheetAction } from "../openBottomSheet";
|
|
|
2
2
|
import { actionExecutor, ActionResult } from "../../ActionExecutor";
|
|
3
3
|
import { modalOrchestrator } from "../../../modalState/ModalOrchestrator";
|
|
4
4
|
|
|
5
|
+
jest.mock("@applicaster/zapp-pipes-v2-client", () => ({
|
|
6
|
+
PipesClientResponseHelper: jest.fn(() => ({ error: null })),
|
|
7
|
+
RequestBuilder: jest.fn(() => ({
|
|
8
|
+
setEntryContext: jest.fn().mockReturnThis(),
|
|
9
|
+
setScreenContext: jest.fn().mockReturnThis(),
|
|
10
|
+
setUrl: jest.fn().mockReturnThis(),
|
|
11
|
+
buildAxiosRequest: jest.fn().mockResolvedValue(undefined),
|
|
12
|
+
call: jest.fn().mockResolvedValue({
|
|
13
|
+
response: {
|
|
14
|
+
entry: [],
|
|
15
|
+
extensions: { dynamic_collection_options: { operations: "add" } },
|
|
16
|
+
},
|
|
17
|
+
}),
|
|
18
|
+
})),
|
|
19
|
+
}));
|
|
20
|
+
|
|
5
21
|
jest.mock("../../../modalState/store", () => ({
|
|
6
22
|
openBottomSheetModal: jest.fn(),
|
|
7
23
|
}));
|
|
@@ -165,6 +181,62 @@ describe("openBottomSheetAction inline items", () => {
|
|
|
165
181
|
expect(menu.content.emptyMessage).toBe("Queued items will be added here");
|
|
166
182
|
});
|
|
167
183
|
|
|
184
|
+
it("forwards content.operationButtons onto the menu", async () => {
|
|
185
|
+
const result = await openBottomSheetAction({
|
|
186
|
+
type: "openBottomSheet",
|
|
187
|
+
options: {
|
|
188
|
+
header: { title: "Playlists" },
|
|
189
|
+
content: {
|
|
190
|
+
items: [{ id: "p1", title: "Playlist 1" }],
|
|
191
|
+
operationButtons: {
|
|
192
|
+
add: {
|
|
193
|
+
title: "Create New Playlist",
|
|
194
|
+
iconURL: "https://example.com/add.png",
|
|
195
|
+
},
|
|
196
|
+
},
|
|
197
|
+
},
|
|
198
|
+
},
|
|
199
|
+
} as any);
|
|
200
|
+
|
|
201
|
+
expect(result).toBe(ActionResult.Success);
|
|
202
|
+
|
|
203
|
+
const [menu] = (modalOrchestrator.open as jest.Mock).mock.calls[0];
|
|
204
|
+
|
|
205
|
+
expect(menu.content.operationButtons).toEqual({
|
|
206
|
+
add: {
|
|
207
|
+
title: "Create New Playlist",
|
|
208
|
+
iconURL: "https://example.com/add.png",
|
|
209
|
+
},
|
|
210
|
+
});
|
|
211
|
+
});
|
|
212
|
+
|
|
213
|
+
it("preserves Add presentation when loading itemsUrl content", async () => {
|
|
214
|
+
const result = await openBottomSheetAction({
|
|
215
|
+
type: "openBottomSheet",
|
|
216
|
+
options: {
|
|
217
|
+
content: {
|
|
218
|
+
itemsUrl: "https://example.com/collections",
|
|
219
|
+
operationButtons: {
|
|
220
|
+
add: {
|
|
221
|
+
title: "Create Collection",
|
|
222
|
+
iconURL: "file:///bundled-add.png",
|
|
223
|
+
},
|
|
224
|
+
},
|
|
225
|
+
},
|
|
226
|
+
},
|
|
227
|
+
});
|
|
228
|
+
|
|
229
|
+
expect(result).toBe(ActionResult.Success);
|
|
230
|
+
const [menu] = (modalOrchestrator.open as jest.Mock).mock.calls[0];
|
|
231
|
+
|
|
232
|
+
expect(menu.content).toMatchObject({
|
|
233
|
+
operationButtons: {
|
|
234
|
+
add: { title: "Create Collection", iconURL: "file:///bundled-add.png" },
|
|
235
|
+
},
|
|
236
|
+
dynamicCollection: { operations: ["add"] },
|
|
237
|
+
});
|
|
238
|
+
});
|
|
239
|
+
|
|
168
240
|
it("pushes a new sheet by default even when another sheet is already open", async () => {
|
|
169
241
|
(modalOrchestrator as any).stackSize = 1;
|
|
170
242
|
|
|
@@ -27,12 +27,10 @@ export const screenToggleFlagAction: ActionHandler<
|
|
|
27
27
|
const screenRoute = context?.screenRoute;
|
|
28
28
|
const screenStateStore = context?.screenStateStore;
|
|
29
29
|
|
|
30
|
-
await screenToggleFlag(
|
|
30
|
+
return await screenToggleFlag(
|
|
31
31
|
screenRoute,
|
|
32
32
|
screenStateStore,
|
|
33
33
|
{ entry: context?.entry, options: action.options },
|
|
34
34
|
action
|
|
35
35
|
);
|
|
36
|
-
|
|
37
|
-
return ActionResult.Success;
|
|
38
36
|
};
|
|
@@ -47,6 +47,11 @@ function makeMultiSelect(feed: ZappFeed, key, decoratedFeed) {
|
|
|
47
47
|
? "sessionStorageToggleFlag"
|
|
48
48
|
: "localStorageToggleFlag";
|
|
49
49
|
|
|
50
|
+
// the toggle actions read their limit from their own options
|
|
51
|
+
const maxItems = Number(
|
|
52
|
+
decoratedFeed.extensions?.preference_editor_options?.max_items
|
|
53
|
+
);
|
|
54
|
+
|
|
50
55
|
decoratedFeed.entry?.forEach((entry: ZappEntry) => {
|
|
51
56
|
entry.type.value = "action";
|
|
52
57
|
entry.id = entry.extensions?.tag || entry.id;
|
|
@@ -59,6 +64,7 @@ function makeMultiSelect(feed: ZappFeed, key, decoratedFeed) {
|
|
|
59
64
|
type: actionType,
|
|
60
65
|
options: {
|
|
61
66
|
key,
|
|
67
|
+
...(maxItems > 0 && { max_items: maxItems }),
|
|
62
68
|
},
|
|
63
69
|
},
|
|
64
70
|
],
|
|
@@ -1,4 +1,7 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import {
|
|
2
|
+
getEmptyModalBlocksStructure,
|
|
3
|
+
parseModalBlocksConfiguration,
|
|
4
|
+
} from "../modalBlocksParser";
|
|
2
5
|
|
|
3
6
|
// Mock the platform selection logic so it's consistent
|
|
4
7
|
jest.mock("../../reactUtils", () => ({
|
|
@@ -151,57 +154,66 @@ describe("parseModalBlocksConfiguration", () => {
|
|
|
151
154
|
);
|
|
152
155
|
});
|
|
153
156
|
|
|
154
|
-
it("should map
|
|
157
|
+
it("should ignore keys that do not map to a known block sub-component", () => {
|
|
155
158
|
const result = parseModalBlocksConfiguration(
|
|
156
159
|
{
|
|
157
160
|
"button.create_new_playlist_asset":
|
|
158
161
|
"https://placehold.co/24x24/FF00FF/FFFFFF/png?text=CN",
|
|
162
|
+
"item.checkbox_asset":
|
|
163
|
+
"https://placehold.co/24x24/FF3B30/FFFFFF/png?text=CB",
|
|
164
|
+
"reorder_playlist_item.reorder_handle_asset":
|
|
165
|
+
"https://placehold.co/24x24/FF3B30/FFFFFF/png?text=RH",
|
|
159
166
|
},
|
|
160
167
|
"playlist-experience"
|
|
161
168
|
);
|
|
162
169
|
|
|
163
|
-
expect(result.button.leadingIcon.default).
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
})
|
|
167
|
-
);
|
|
170
|
+
expect(result.button.leadingIcon.default?.asset).toBeUndefined();
|
|
171
|
+
expect(result.item.checkbox.default).toBeUndefined();
|
|
172
|
+
expect(result.item.actionButtons.default).toBeUndefined();
|
|
168
173
|
});
|
|
169
174
|
|
|
170
|
-
it("
|
|
175
|
+
it("parses the generic button leading icon asset", () => {
|
|
171
176
|
const result = parseModalBlocksConfiguration(
|
|
172
|
-
{
|
|
173
|
-
"item.checkbox_asset":
|
|
174
|
-
"https://placehold.co/24x24/FF3B30/FFFFFF/png?text=CB",
|
|
175
|
-
"item.checked_checkbox_asset":
|
|
176
|
-
"https://placehold.co/24x24/FFD60A/000000/png?text=CK",
|
|
177
|
-
},
|
|
177
|
+
{ "button.leading_icon.asset": "https://example.com/add.png" },
|
|
178
178
|
"playlist-experience"
|
|
179
179
|
);
|
|
180
180
|
|
|
181
|
-
expect(result.
|
|
182
|
-
|
|
183
|
-
asset: "https://placehold.co/24x24/FF3B30/FFFFFF/png?text=CB",
|
|
184
|
-
checkedAsset: "https://placehold.co/24x24/FFD60A/000000/png?text=CK",
|
|
185
|
-
})
|
|
181
|
+
expect(result.button.leadingIcon.default?.asset).toBe(
|
|
182
|
+
"https://example.com/add.png"
|
|
186
183
|
);
|
|
187
184
|
});
|
|
185
|
+
});
|
|
188
186
|
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
"reorder_playlist_item.remove_from_playlist_asset":
|
|
193
|
-
"https://placehold.co/24x24/00FF00/000000/png?text=RM",
|
|
194
|
-
"reorder_playlist_item.reorder_handle_asset":
|
|
195
|
-
"https://placehold.co/24x24/FF3B30/FFFFFF/png?text=RH",
|
|
196
|
-
},
|
|
197
|
-
"playlist-experience"
|
|
198
|
-
);
|
|
187
|
+
describe("getEmptyModalBlocksStructure", () => {
|
|
188
|
+
it("should return every block with empty containers and no state entries", () => {
|
|
189
|
+
const result = getEmptyModalBlocksStructure();
|
|
199
190
|
|
|
200
|
-
expect(result.
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
191
|
+
expect(result.header.container).toEqual({});
|
|
192
|
+
expect(result.item.background).toEqual({});
|
|
193
|
+
expect(result.button.background).toEqual({});
|
|
194
|
+
expect(result.action.background).toEqual({});
|
|
195
|
+
|
|
196
|
+
expect(result.button.leadingIcon.default).toBeUndefined();
|
|
197
|
+
expect(result.item.checkbox.default).toBeUndefined();
|
|
198
|
+
expect(result.item.actionButtons.default).toBeUndefined();
|
|
199
|
+
});
|
|
200
|
+
|
|
201
|
+
it("should return a fresh object on every call", () => {
|
|
202
|
+
const first = getEmptyModalBlocksStructure();
|
|
203
|
+
const second = getEmptyModalBlocksStructure();
|
|
204
|
+
|
|
205
|
+
expect(first).not.toBe(second);
|
|
206
|
+
expect(first.header).not.toBe(second.header);
|
|
207
|
+
expect(first).toEqual(second);
|
|
208
|
+
});
|
|
209
|
+
|
|
210
|
+
it("should be what the parser returns when config or componentName is missing", () => {
|
|
211
|
+
expect(
|
|
212
|
+
parseModalBlocksConfiguration(undefined as any, "queue_action")
|
|
213
|
+
).toEqual(getEmptyModalBlocksStructure());
|
|
214
|
+
|
|
215
|
+
expect(parseModalBlocksConfiguration({ foo: "bar" }, "")).toEqual(
|
|
216
|
+
getEmptyModalBlocksStructure()
|
|
205
217
|
);
|
|
206
218
|
});
|
|
207
219
|
|
|
@@ -60,10 +60,7 @@ export type ModalBlocksConfig = {
|
|
|
60
60
|
};
|
|
61
61
|
};
|
|
62
62
|
|
|
63
|
-
export const
|
|
64
|
-
configuration: Record<string, any>,
|
|
65
|
-
componentName: string
|
|
66
|
-
): ModalBlocksConfig => {
|
|
63
|
+
export const getEmptyModalBlocksStructure = (): ModalBlocksConfig => {
|
|
67
64
|
const result: ModalBlocksConfig = {
|
|
68
65
|
header: {
|
|
69
66
|
container: {},
|
|
@@ -118,6 +115,15 @@ export const parseModalBlocksConfiguration = (
|
|
|
118
115
|
},
|
|
119
116
|
};
|
|
120
117
|
|
|
118
|
+
return result;
|
|
119
|
+
};
|
|
120
|
+
|
|
121
|
+
export const parseModalBlocksConfiguration = (
|
|
122
|
+
configuration: Record<string, any>,
|
|
123
|
+
componentName: string
|
|
124
|
+
): ModalBlocksConfig => {
|
|
125
|
+
const result = getEmptyModalBlocksStructure();
|
|
126
|
+
|
|
121
127
|
if (!configuration || !componentName) {
|
|
122
128
|
return result;
|
|
123
129
|
}
|
|
@@ -242,107 +248,5 @@ export const parseModalBlocksConfiguration = (
|
|
|
242
248
|
|
|
243
249
|
assignLeafAsset(result.item, "item.reorder_handle_asset", "dragAsset");
|
|
244
250
|
|
|
245
|
-
// Playlist-experience Studio keys live in this shared parser because modal
|
|
246
|
-
// blocks are themed by themePluginId. Gate them so other plugins are not
|
|
247
|
-
// affected by playlist-only asset names.
|
|
248
|
-
const isPlaylistExperience =
|
|
249
|
-
normalizedComponentName === "playlist_experience";
|
|
250
|
-
|
|
251
|
-
// Studio uploads Create New icon as button.create_new_playlist_asset (not
|
|
252
|
-
// button.leading_icon.asset). Map it onto leadingIcon so AudioPlayerButton
|
|
253
|
-
// can override the hardcoded action-type asset.
|
|
254
|
-
const createNewPlaylistAsset = isPlaylistExperience
|
|
255
|
-
? configuration["button.create_new_playlist_asset"] ||
|
|
256
|
-
configuration[
|
|
257
|
-
`${normalizedComponentName}_button_create_new_playlist_asset`
|
|
258
|
-
]
|
|
259
|
-
: undefined;
|
|
260
|
-
|
|
261
|
-
if (createNewPlaylistAsset) {
|
|
262
|
-
if (!result.button.leadingIcon.default) {
|
|
263
|
-
result.button.leadingIcon.default = {};
|
|
264
|
-
}
|
|
265
|
-
|
|
266
|
-
result.button.leadingIcon.default.asset = createNewPlaylistAsset;
|
|
267
|
-
}
|
|
268
|
-
|
|
269
|
-
// Studio checkbox assets are top-level item.* keys (not a parseBlock
|
|
270
|
-
// sub-component). Map onto item.checkbox so multiSelect can render them.
|
|
271
|
-
const checkboxAsset =
|
|
272
|
-
configuration["item.checkbox_asset"] ||
|
|
273
|
-
configuration[`${normalizedComponentName}_item_checkbox_asset`];
|
|
274
|
-
|
|
275
|
-
const checkedCheckboxAsset =
|
|
276
|
-
configuration["item.checked_checkbox_asset"] ||
|
|
277
|
-
configuration[`${normalizedComponentName}_item_checked_checkbox_asset`];
|
|
278
|
-
|
|
279
|
-
if (checkboxAsset || checkedCheckboxAsset) {
|
|
280
|
-
if (!result.item.checkbox.default) {
|
|
281
|
-
result.item.checkbox.default = {};
|
|
282
|
-
}
|
|
283
|
-
|
|
284
|
-
if (checkboxAsset) {
|
|
285
|
-
result.item.checkbox.default.asset = checkboxAsset;
|
|
286
|
-
}
|
|
287
|
-
|
|
288
|
-
if (checkedCheckboxAsset) {
|
|
289
|
-
result.item.checkbox.default.checkedAsset = checkedCheckboxAsset;
|
|
290
|
-
}
|
|
291
|
-
}
|
|
292
|
-
|
|
293
|
-
// Edit Order row icons: prefer reorder_playlist_item.*, then flavor1, then
|
|
294
|
-
// flavor2 playlist_experience_assets_* (playlist-experience theme only).
|
|
295
|
-
const removeAsset = isPlaylistExperience
|
|
296
|
-
? configuration["reorder_playlist_item.remove_from_playlist_asset"] ||
|
|
297
|
-
configuration[
|
|
298
|
-
`${normalizedComponentName}_reorder_playlist_item_remove_from_playlist_asset`
|
|
299
|
-
] ||
|
|
300
|
-
configuration[
|
|
301
|
-
"playlist_experience_assets_flavor1.remove_from_playlist_asset"
|
|
302
|
-
] ||
|
|
303
|
-
configuration[
|
|
304
|
-
`${normalizedComponentName}_assets_flavor1_remove_from_playlist_asset`
|
|
305
|
-
] ||
|
|
306
|
-
configuration[
|
|
307
|
-
"playlist_experience_assets_flavor2.remove_from_playlist_asset"
|
|
308
|
-
] ||
|
|
309
|
-
configuration[
|
|
310
|
-
`${normalizedComponentName}_assets_flavor2_remove_from_playlist_asset`
|
|
311
|
-
]
|
|
312
|
-
: undefined;
|
|
313
|
-
|
|
314
|
-
const dragAsset = isPlaylistExperience
|
|
315
|
-
? configuration["reorder_playlist_item.reorder_handle_asset"] ||
|
|
316
|
-
configuration[
|
|
317
|
-
`${normalizedComponentName}_reorder_playlist_item_reorder_handle_asset`
|
|
318
|
-
] ||
|
|
319
|
-
configuration[
|
|
320
|
-
"playlist_experience_assets_flavor1.reorder_handle_asset"
|
|
321
|
-
] ||
|
|
322
|
-
configuration[
|
|
323
|
-
`${normalizedComponentName}_assets_flavor1_reorder_handle_asset`
|
|
324
|
-
] ||
|
|
325
|
-
configuration[
|
|
326
|
-
"playlist_experience_assets_flavor2.reorder_handle_asset"
|
|
327
|
-
] ||
|
|
328
|
-
configuration[
|
|
329
|
-
`${normalizedComponentName}_assets_flavor2_reorder_handle_asset`
|
|
330
|
-
]
|
|
331
|
-
: undefined;
|
|
332
|
-
|
|
333
|
-
if (removeAsset || dragAsset) {
|
|
334
|
-
if (!result.item.actionButtons.default) {
|
|
335
|
-
result.item.actionButtons.default = {};
|
|
336
|
-
}
|
|
337
|
-
|
|
338
|
-
if (removeAsset) {
|
|
339
|
-
result.item.actionButtons.default.removeAsset = removeAsset;
|
|
340
|
-
}
|
|
341
|
-
|
|
342
|
-
if (dragAsset) {
|
|
343
|
-
result.item.actionButtons.default.dragAsset = dragAsset;
|
|
344
|
-
}
|
|
345
|
-
}
|
|
346
|
-
|
|
347
251
|
return result;
|
|
348
252
|
};
|
|
@@ -60,7 +60,7 @@ describe("buildEntryActions - alias & label resolution", () => {
|
|
|
60
60
|
expect(state.label).toBe("Label Property Action");
|
|
61
61
|
});
|
|
62
62
|
|
|
63
|
-
it("
|
|
63
|
+
it("humanizes an un-overridden alias and falls back to the placeholder asset", () => {
|
|
64
64
|
const entry = {
|
|
65
65
|
id: "entry-3",
|
|
66
66
|
extensions: {
|
|
@@ -71,11 +71,7 @@ describe("buildEntryActions - alias & label resolution", () => {
|
|
|
71
71
|
dismiss_on_action: true,
|
|
72
72
|
},
|
|
73
73
|
{
|
|
74
|
-
button: { alias: "
|
|
75
|
-
actions: [{ type: "test" }],
|
|
76
|
-
},
|
|
77
|
-
{
|
|
78
|
-
button: { alias: "delete_collection" },
|
|
74
|
+
button: { alias: "custom_unknown_action" },
|
|
79
75
|
actions: [{ type: "test" }],
|
|
80
76
|
},
|
|
81
77
|
],
|
|
@@ -84,42 +80,86 @@ describe("buildEntryActions - alias & label resolution", () => {
|
|
|
84
80
|
|
|
85
81
|
const actions = resolveEntryActions(entry as any);
|
|
86
82
|
|
|
87
|
-
expect(actions).toHaveLength(
|
|
83
|
+
expect(actions).toHaveLength(2);
|
|
88
84
|
|
|
85
|
+
// No built-in alias vocabulary any more: underscores become spaces and
|
|
86
|
+
// only the first letter is capitalized, so "queue" stays lowercase.
|
|
89
87
|
expect(actions[0].action.initialEntryState(entry as any)).toMatchObject({
|
|
90
88
|
state: 0,
|
|
91
|
-
label: "Add all to
|
|
89
|
+
label: "Add all to queue",
|
|
92
90
|
});
|
|
93
91
|
|
|
94
92
|
expect(actions[1].action.initialEntryState(entry as any)).toMatchObject({
|
|
95
93
|
state: 0,
|
|
96
|
-
label: "
|
|
94
|
+
label: "Custom unknown action",
|
|
97
95
|
});
|
|
98
96
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
97
|
+
// The asset has no such fallback: without an override it is the red-box
|
|
98
|
+
// placeholder, so a missing Studio icon is visible rather than absent.
|
|
99
|
+
for (const action of actions) {
|
|
100
|
+
expect(action.action.initialEntryState(entry as any)).toMatchObject({
|
|
101
|
+
asset: expect.stringMatching(/^data:image\/png;base64,/),
|
|
102
|
+
});
|
|
103
|
+
}
|
|
103
104
|
});
|
|
104
105
|
|
|
105
|
-
it("
|
|
106
|
+
it("prefers aliasPresentation overrides over the humanized fallbacks", () => {
|
|
107
|
+
const deps = {
|
|
108
|
+
actionExecutor: { handleActions: jest.fn() } as any,
|
|
109
|
+
actionContext: {},
|
|
110
|
+
aliasPresentation: {
|
|
111
|
+
labels: { add_all_to_queue: "Add all to Queue" },
|
|
112
|
+
assets: { add_all_to_queue: "http://example.com/queue.png" },
|
|
113
|
+
},
|
|
114
|
+
};
|
|
115
|
+
|
|
106
116
|
const entry = {
|
|
107
117
|
id: "entry-4",
|
|
108
118
|
extensions: {
|
|
109
119
|
entry_action: [
|
|
110
120
|
{
|
|
111
|
-
button: { alias: "
|
|
121
|
+
button: { alias: "add_all_to_queue" },
|
|
122
|
+
actions: [{ type: "test" }],
|
|
123
|
+
},
|
|
124
|
+
{
|
|
125
|
+
button: { alias: "not_overridden" },
|
|
112
126
|
actions: [{ type: "test" }],
|
|
113
127
|
},
|
|
114
128
|
],
|
|
115
129
|
},
|
|
116
130
|
};
|
|
117
131
|
|
|
118
|
-
const actions =
|
|
132
|
+
const actions = buildEntryActions(entry as any, deps);
|
|
119
133
|
|
|
120
|
-
expect(actions).
|
|
134
|
+
expect(actions[0].action.initialEntryState(entry as any)).toMatchObject({
|
|
135
|
+
label: "Add all to Queue",
|
|
136
|
+
asset: "http://example.com/queue.png",
|
|
137
|
+
});
|
|
138
|
+
|
|
139
|
+
// Overrides are per-alias, so an alias absent from the map still humanizes.
|
|
140
|
+
expect(actions[1].action.initialEntryState(entry as any)).toMatchObject({
|
|
141
|
+
label: "Not overridden",
|
|
142
|
+
});
|
|
143
|
+
});
|
|
144
|
+
|
|
145
|
+
it("returns no asset when the button has neither iconURL nor alias", () => {
|
|
146
|
+
const entry = {
|
|
147
|
+
id: "entry-5",
|
|
148
|
+
extensions: {
|
|
149
|
+
entry_action: [
|
|
150
|
+
{
|
|
151
|
+
button: { label: "Plain Label" },
|
|
152
|
+
actions: [{ type: "test" }],
|
|
153
|
+
},
|
|
154
|
+
],
|
|
155
|
+
},
|
|
156
|
+
};
|
|
157
|
+
|
|
158
|
+
const actions = resolveEntryActions(entry as any);
|
|
121
159
|
const state = actions[0].action.initialEntryState(entry as any);
|
|
122
|
-
|
|
160
|
+
|
|
161
|
+
expect(state.label).toBe("Plain Label");
|
|
162
|
+
expect(state.asset).toBeUndefined();
|
|
123
163
|
});
|
|
124
164
|
|
|
125
165
|
it("uses actionExecutor.getActionState for plugin-provided label and asset", () => {
|
|
@@ -1,52 +1,29 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Presentation
|
|
2
|
+
* Presentation fallbacks for backend action aliases.
|
|
3
3
|
*
|
|
4
4
|
* Entries may declare an action by `alias` alone, without a label or an icon.
|
|
5
|
-
*
|
|
6
|
-
*
|
|
5
|
+
* There is no built-in alias vocabulary: a label falls back to a humanized
|
|
6
|
+
* version of the alias itself, and an icon falls back to an inline placeholder
|
|
7
|
+
* that is deliberately conspicuous, so a missing asset reads as unconfigured
|
|
8
|
+
* rather than as a deliberate blank.
|
|
7
9
|
*
|
|
8
|
-
*
|
|
9
|
-
* alias vocabulary
|
|
10
|
-
*
|
|
10
|
+
* Both are last resorts, not a framework guarantee: an app that speaks its own
|
|
11
|
+
* alias vocabulary or needs other languages passes labels and assets through
|
|
12
|
+
* `EntryActionDeps.aliasPresentation`, which is consulted per alias.
|
|
11
13
|
*/
|
|
12
14
|
|
|
13
15
|
import { EntryAction } from "./types";
|
|
14
16
|
|
|
15
|
-
|
|
16
|
-
"https://assets-secure.applicaster.com/zapp/assets/app_family/1710/906728572617/playlist_add_24dp_FFFFFF_FILL0_wght400_GRAD0_opsz24.png";
|
|
17
|
-
|
|
18
|
-
const REMOVE_ICON =
|
|
19
|
-
"https://assets-secure.applicaster.com/zapp/assets/app_family/1710/372097240191/remove_24dp_EA3323_FILL0_wght400_GRAD0_opsz24.png";
|
|
20
|
-
|
|
21
|
-
const EDIT_ICON =
|
|
22
|
-
"https://upload.wikimedia.org/wikipedia/commons/b/b6/Edit-icon.png";
|
|
23
|
-
|
|
24
|
-
/** Known backend action alias labels. */
|
|
25
|
-
export const ALIAS_LABELS: Record<string, string> = {
|
|
26
|
-
add_to_playlist: "Add to Playlist",
|
|
27
|
-
add_to_queue: "Add to Queue",
|
|
28
|
-
add_all_to_queue: "Add all to Queue",
|
|
29
|
-
play_all: "Play All",
|
|
30
|
-
remove_item: "Remove item",
|
|
31
|
-
delete_collection: "Delete collection",
|
|
32
|
-
create_collection: "Create collection",
|
|
33
|
-
edit: "Edit",
|
|
34
|
-
edit_name: "Edit Name & Details",
|
|
35
|
-
};
|
|
17
|
+
import { createLogger } from "@applicaster/zapp-react-native-utils/logger";
|
|
36
18
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
remove_item: REMOVE_ICON,
|
|
44
|
-
delete_collection: REMOVE_ICON,
|
|
45
|
-
edit: EDIT_ICON,
|
|
46
|
-
edit_name: EDIT_ICON,
|
|
47
|
-
};
|
|
19
|
+
const logger = createLogger({
|
|
20
|
+
category: "zapp-react-native-utils:aliasPresentation",
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
const PLACEHOLDER_RED_BOX =
|
|
24
|
+
"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAJ0lEQVR4nO3NMQEAAAjDsIF/z2ACvlRAU5NMHuvPOQAAAAAAAMBdC/07Ai5sNw+CAAAAAElFTkSuQmCC";
|
|
48
25
|
|
|
49
|
-
/** Per-app
|
|
26
|
+
/** Per-app labels and icons, keyed by alias, that outrank the fallbacks. */
|
|
50
27
|
export type AliasPresentation = {
|
|
51
28
|
labels?: Record<string, string>;
|
|
52
29
|
assets?: Record<string, string>;
|
|
@@ -56,7 +33,7 @@ function formatAliasLabel(
|
|
|
56
33
|
alias: string,
|
|
57
34
|
overrides?: AliasPresentation
|
|
58
35
|
): string {
|
|
59
|
-
const label = overrides?.labels?.[alias]
|
|
36
|
+
const label = overrides?.labels?.[alias];
|
|
60
37
|
|
|
61
38
|
if (label) {
|
|
62
39
|
return label;
|
|
@@ -107,7 +84,7 @@ export function resolveButtonLabel(
|
|
|
107
84
|
return "";
|
|
108
85
|
}
|
|
109
86
|
|
|
110
|
-
/** Icon to show for an entry action: explicit iconURL,
|
|
87
|
+
/** Icon to show for an entry action: explicit iconURL, matching alias asset or fallback to red box. */
|
|
111
88
|
export function resolveButtonAsset(
|
|
112
89
|
button: EntryAction["button"],
|
|
113
90
|
overrides?: AliasPresentation
|
|
@@ -120,5 +97,12 @@ export function resolveButtonAsset(
|
|
|
120
97
|
return undefined;
|
|
121
98
|
}
|
|
122
99
|
|
|
123
|
-
|
|
100
|
+
if (!overrides?.assets?.[button.alias]) {
|
|
101
|
+
logger.log_warning(
|
|
102
|
+
`Entry action alias '${button.alias}' was not resolved by any plugin feedDecorator or app override. Falling back to placeholder red box.`,
|
|
103
|
+
{ data: { button } }
|
|
104
|
+
);
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
return overrides?.assets?.[button.alias] ?? PLACEHOLDER_RED_BOX;
|
|
124
108
|
}
|
package/entryActions/index.ts
CHANGED
|
@@ -60,4 +60,27 @@ describe("ModalOrchestrator phase 3", () => {
|
|
|
60
60
|
|
|
61
61
|
expect(props.emptyMessage).toBe("Queued items will be added here");
|
|
62
62
|
});
|
|
63
|
+
|
|
64
|
+
it("forwards operationButtons onto the sheet props unchanged", () => {
|
|
65
|
+
const operationButtons = {
|
|
66
|
+
add: {
|
|
67
|
+
title: "Create New Playlist",
|
|
68
|
+
iconURL: "https://example.com/add.png",
|
|
69
|
+
},
|
|
70
|
+
};
|
|
71
|
+
|
|
72
|
+
modalOrchestrator.open({
|
|
73
|
+
header: { title: "Playlists" },
|
|
74
|
+
content: {
|
|
75
|
+
title: "Playlists",
|
|
76
|
+
items: [],
|
|
77
|
+
operationButtons,
|
|
78
|
+
},
|
|
79
|
+
});
|
|
80
|
+
|
|
81
|
+
const props = (modalStore.getState().modalState.screen as any)
|
|
82
|
+
?.modalBottomSheetContentProps;
|
|
83
|
+
|
|
84
|
+
expect(props.operationButtons).toEqual(operationButtons);
|
|
85
|
+
});
|
|
63
86
|
});
|
package/modalState/index.ts
CHANGED
package/modalState/types.ts
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import type { EntryAction } from "../entryActions/types";
|
|
2
|
+
|
|
1
3
|
export interface Header {
|
|
2
4
|
title: string;
|
|
3
5
|
subtitle?: string;
|
|
@@ -107,6 +109,13 @@ export interface DynamicCollectionOptions {
|
|
|
107
109
|
events?: Record<CollectionScopedOperation | string, Action[]>;
|
|
108
110
|
}
|
|
109
111
|
|
|
112
|
+
/** Presentation of a sheet-synthesized operation control; same fields as an entry action button. */
|
|
113
|
+
export type OperationButton = Pick<EntryAction["button"], "title" | "iconURL">;
|
|
114
|
+
|
|
115
|
+
export type OperationButtons = Partial<
|
|
116
|
+
Record<CollectionScopedOperation | string, OperationButton>
|
|
117
|
+
>;
|
|
118
|
+
|
|
110
119
|
export interface Content {
|
|
111
120
|
title: string;
|
|
112
121
|
stickyTitle?: boolean;
|
|
@@ -120,6 +129,8 @@ export interface Content {
|
|
|
120
129
|
styleOverrides?: Record<string, any>;
|
|
121
130
|
/** Shown under Next Up when the queue sheet has no upcoming items. */
|
|
122
131
|
emptyMessage?: string;
|
|
132
|
+
/** Producer-owned presentation for sheet-synthesized operation controls (e.g. `add`). */
|
|
133
|
+
operationButtons?: OperationButtons;
|
|
123
134
|
context?: Record<string, any>;
|
|
124
135
|
}
|
|
125
136
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@applicaster/zapp-react-native-utils",
|
|
3
|
-
"version": "15.1.
|
|
3
|
+
"version": "15.1.23-alpha.1501426102",
|
|
4
4
|
"description": "Applicaster Zapp React Native utilities package",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"types": "index.d.ts",
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
},
|
|
28
28
|
"homepage": "https://github.com/applicaster/quickbrick#readme",
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@applicaster/applicaster-types": "15.1.
|
|
30
|
+
"@applicaster/applicaster-types": "15.1.23-alpha.1501426102",
|
|
31
31
|
"buffer": "^5.2.1",
|
|
32
32
|
"camelize": "^1.0.0",
|
|
33
33
|
"dayjs": "^1.11.10",
|