@applicaster/zapp-react-native-utils 16.0.0-alpha.1803625751 → 16.0.0-alpha.1816065263
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/ActionExecutor.ts +8 -10
- package/actionsExecutor/ActionExecutorContext.tsx +41 -325
- package/actionsExecutor/actions/__tests__/showToast.test.ts +88 -0
- package/actionsExecutor/actions/appRestart.ts +24 -0
- package/actionsExecutor/actions/confirmDialog.ts +53 -0
- package/actionsExecutor/actions/index.ts +30 -0
- package/actionsExecutor/actions/localStorageRemove.ts +27 -0
- package/actionsExecutor/actions/localStorageSet.ts +28 -0
- package/actionsExecutor/actions/localStorageToggleFlag.ts +28 -0
- package/actionsExecutor/actions/navigateToScreen.ts +123 -0
- package/actionsExecutor/actions/refreshComponent.ts +79 -0
- package/actionsExecutor/actions/screenSetVariable.ts +35 -0
- package/actionsExecutor/actions/screenToggleFlag.ts +38 -0
- package/actionsExecutor/actions/sendCloudEvent.ts +88 -0
- package/actionsExecutor/actions/sessionStorageRemove.ts +19 -0
- package/actionsExecutor/actions/sessionStorageSet.ts +20 -0
- package/actionsExecutor/actions/sessionStorageToggleFlag.ts +15 -0
- package/actionsExecutor/actions/showToast.ts +87 -0
- package/actionsExecutor/actions/switchLayout.ts +40 -0
- package/actionsExecutor/types.ts +59 -0
- package/analyticsUtils/PlayerAnalyticsManager.ts +1 -1
- package/appUtils/contextKeysManager/__tests__/getKey/failure.test.ts +1 -1
- package/appUtils/contextKeysManager/__tests__/removeKey/failure.test.ts +1 -1
- package/appUtils/contextKeysManager/__tests__/setKey/failure/invalidKey.test.ts +4 -4
- package/appUtils/contextKeysManager/index.ts +1 -1
- package/appUtils/playerManager/OverlayObserver/OverlaysObserver.ts +138 -51
- package/appUtils/playerManager/OverlayObserver/__tests__/liveContent.test.ts +205 -0
- package/appUtils/playerManager/__tests__/playerContent.test.ts +403 -0
- package/appUtils/playerManager/__tests__/playerFactory.test.ts +1 -1
- package/appUtils/playerManager/__tests__/usePlayerContent.test.tsx +64 -0
- package/appUtils/playerManager/{conts.ts → const.ts} +20 -0
- package/appUtils/playerManager/index.ts +1 -1
- package/appUtils/playerManager/player.ts +115 -3
- package/appUtils/playerManager/playerFactory.ts +1 -1
- package/appUtils/playerManager/playerNative.ts +1 -1
- package/appUtils/playerManager/usePlayerContent.tsx +43 -0
- package/appUtils/playerManager/usePlayerControllerSetup.tsx +1 -1
- package/appUtils/playerManager/userLanguagePreference.ts +1 -1
- package/arrayUtils/__tests__/{anyThruthy.test.ts → anyTruthy.test.ts} +8 -0
- package/arrayUtils/__tests__/arrayUtils.test.ts +165 -108
- package/arrayUtils/__tests__/isEmptyArray.test.ts +11 -0
- package/arrayUtils/__tests__/isFilledArray.test.ts +12 -0
- package/arrayUtils/__tests__/isFirst.test.ts +17 -0
- package/arrayUtils/__tests__/isIndexInRange.test.ts +14 -0
- package/arrayUtils/__tests__/isLast.test.ts +31 -0
- package/arrayUtils/__tests__/makeListOf.test.ts +31 -0
- package/arrayUtils/__tests__/makeListOfIndexes.test.ts +20 -0
- package/arrayUtils/__tests__/sample.test.ts +61 -0
- package/arrayUtils/index.ts +57 -20
- package/bottomSheet/__tests__/scrollContext.test.tsx +35 -0
- package/bottomSheet/index.ts +17 -0
- package/cellUtils/index.ts +3 -5
- package/colorUtils/__tests__/isTransparentColor.test.ts +76 -0
- package/colorUtils/__tests__/isValidColor.test.ts +70 -0
- package/colorUtils/index.ts +50 -0
- package/manifestUtils/_internals/index.js +6 -0
- package/manifestUtils/defaultManifestConfigurations/player.js +185 -19
- package/manifestUtils/fieldUtils/__tests__/fieldUtils.test.js +84 -0
- package/manifestUtils/fieldUtils/index.js +125 -0
- package/manifestUtils/keys.js +9 -0
- package/manifestUtils/mobileAction/button/index.js +16 -0
- package/manifestUtils/mobileAction/container/index.js +3 -1
- package/manifestUtils/mobileAction/groups/defaults.js +3 -1
- package/manifestUtils/platformIsTV.js +1 -0
- package/numberUtils/__tests__/isMinusZero.test.ts +20 -0
- package/numberUtils/__tests__/isZero.test.ts +27 -0
- package/numberUtils/__tests__/requireNumber.test.ts +50 -0
- package/numberUtils/__tests__/toNumber.test.ts +27 -0
- package/numberUtils/__tests__/toNumberWithDefault.test.ts +64 -0
- package/numberUtils/__tests__/toNumberWithDefaultZero.test.ts +48 -0
- package/numberUtils/index.ts +27 -8
- package/package.json +2 -2
- package/pipesUtils/__tests__/buildUrlWithQuery.test.ts +33 -0
- package/pipesUtils/__tests__/withPipesEndpoint.test.tsx +56 -0
- package/pipesUtils/index.ts +1 -0
- package/pipesUtils/withPipesEndpoint.tsx +54 -0
- package/playerUtils/__tests__/contentDataKeys.test.ts +297 -0
- package/playerUtils/__tests__/resolvePlayerTitleSubtitle.test.ts +180 -0
- package/playerUtils/contentDataKeys.ts +134 -0
- package/playerUtils/index.ts +20 -15
- package/playerUtils/isAudioItem.ts +26 -0
- package/playerUtils/resolvePlayerTitleSubtitle.ts +76 -0
- package/reactHooks/actions/index.ts +51 -1
- package/reactHooks/cell-click/index.ts +3 -3
- package/reactHooks/feed/__mocks__/useMarkPipesDataStale.ts +4 -0
- package/reactHooks/feed/__tests__/useInflatedUrl.test.tsx +25 -0
- package/reactHooks/feed/index.ts +5 -1
- package/reactHooks/feed/useBatchLoading.ts +9 -1
- package/reactHooks/feed/{usePipesCacheReset.ts → useMarkPipesDataStale.ts} +12 -4
- package/reactHooks/layout/index.ts +1 -1
- package/reactHooks/navigation/__mocks__/index.ts +4 -0
- package/reactHooks/navigation/__tests__/useIsScreenActive.test.ts +42 -0
- package/reactHooks/navigation/index.ts +1 -1
- package/reactHooks/navigation/useIsScreenActive.ts +29 -8
- package/reactHooks/state/useComponentScreenState.ts +1 -1
- package/reactHooks/utils/index.ts +3 -2
- package/riverComponetsMeasurementProvider/index.tsx +12 -8
- package/stringUtils/__tests__/stringUtils.test.js +42 -0
- package/stringUtils/index.ts +2 -2
- package/uiActionsRegistrator/index.ts +203 -0
- package/zappFrameworkUtils/__tests__/localStorageHelper.test.ts +146 -0
- package/zappFrameworkUtils/localStorageHelper.ts +19 -15
- package/appUtils/playerManager/usePlayerTitleSummaryOverlay.tsx +0 -56
- package/reactHooks/feed/__mocks__/usePipesCacheReset.ts +0 -1
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
import {
|
|
2
|
+
resolvePlayerTitleSubtitle,
|
|
3
|
+
getPlayerContentDataKeys,
|
|
4
|
+
} from "../resolvePlayerTitleSubtitle";
|
|
5
|
+
import {
|
|
6
|
+
VIDEO_PLAYER_CONTENT_DATA_KEYS,
|
|
7
|
+
AUDIO_PLAYER_CONTENT_DATA_KEYS,
|
|
8
|
+
} from "../contentDataKeys";
|
|
9
|
+
|
|
10
|
+
const entry = {
|
|
11
|
+
id: "1",
|
|
12
|
+
title: "Default Title",
|
|
13
|
+
summary: "Default Summary",
|
|
14
|
+
extensions: {
|
|
15
|
+
episode_name: "Custom Episode",
|
|
16
|
+
episode_subtitle: "Custom Subtitle",
|
|
17
|
+
},
|
|
18
|
+
} as unknown as ZappEntry;
|
|
19
|
+
|
|
20
|
+
describe("resolvePlayerTitleSubtitle", () => {
|
|
21
|
+
it("returns entry.title/entry.summary when nothing is configured", () => {
|
|
22
|
+
expect(
|
|
23
|
+
resolvePlayerTitleSubtitle({ entry, pluginConfiguration: {} })
|
|
24
|
+
).toEqual({
|
|
25
|
+
title: "Default Title",
|
|
26
|
+
summary: "Default Summary",
|
|
27
|
+
});
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
it("returns entry.title/entry.summary when pluginConfiguration is undefined", () => {
|
|
31
|
+
expect(
|
|
32
|
+
resolvePlayerTitleSubtitle({ entry, pluginConfiguration: undefined })
|
|
33
|
+
).toEqual({
|
|
34
|
+
title: "Default Title",
|
|
35
|
+
summary: "Default Summary",
|
|
36
|
+
});
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
it("returns null for both fields without throwing when entry is missing", () => {
|
|
40
|
+
expect(
|
|
41
|
+
resolvePlayerTitleSubtitle({
|
|
42
|
+
entry: undefined,
|
|
43
|
+
pluginConfiguration: {
|
|
44
|
+
title_data_key_source: "other",
|
|
45
|
+
title_custom_data_key: "extensions.episode_name",
|
|
46
|
+
},
|
|
47
|
+
})
|
|
48
|
+
).toEqual({ title: null, summary: null });
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
it("does not mutate the entry it is given", () => {
|
|
52
|
+
const original = JSON.parse(JSON.stringify(entry));
|
|
53
|
+
|
|
54
|
+
resolvePlayerTitleSubtitle({
|
|
55
|
+
entry,
|
|
56
|
+
pluginConfiguration: {
|
|
57
|
+
title_data_key_source: "other",
|
|
58
|
+
title_custom_data_key: "extensions.episode_name",
|
|
59
|
+
},
|
|
60
|
+
});
|
|
61
|
+
|
|
62
|
+
expect(entry).toEqual(original);
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
describe("default (mobile) key set", () => {
|
|
66
|
+
it("resolves the title from the default (mobile) custom data key", () => {
|
|
67
|
+
expect(
|
|
68
|
+
resolvePlayerTitleSubtitle({
|
|
69
|
+
entry,
|
|
70
|
+
pluginConfiguration: {
|
|
71
|
+
title_data_key_source: "other",
|
|
72
|
+
title_custom_data_key: "extensions.episode_name",
|
|
73
|
+
},
|
|
74
|
+
})
|
|
75
|
+
).toEqual({
|
|
76
|
+
title: "Custom Episode",
|
|
77
|
+
summary: "Default Summary",
|
|
78
|
+
});
|
|
79
|
+
});
|
|
80
|
+
|
|
81
|
+
it("ignores TV-only custom data keys", () => {
|
|
82
|
+
expect(
|
|
83
|
+
resolvePlayerTitleSubtitle({
|
|
84
|
+
entry,
|
|
85
|
+
pluginConfiguration: {
|
|
86
|
+
video_player_title_data_key_source: "other",
|
|
87
|
+
video_player_title_custom_data_key: "extensions.episode_name",
|
|
88
|
+
},
|
|
89
|
+
})
|
|
90
|
+
).toEqual({
|
|
91
|
+
title: "Default Title",
|
|
92
|
+
summary: "Default Summary",
|
|
93
|
+
});
|
|
94
|
+
});
|
|
95
|
+
});
|
|
96
|
+
|
|
97
|
+
describe("dataKeys parameter (e.g. VIDEO_PLAYER_CONTENT_DATA_KEYS)", () => {
|
|
98
|
+
it("resolves the title from the TV video custom data key when dataKeys is VIDEO_PLAYER_CONTENT_DATA_KEYS", () => {
|
|
99
|
+
expect(
|
|
100
|
+
resolvePlayerTitleSubtitle({
|
|
101
|
+
entry,
|
|
102
|
+
pluginConfiguration: {
|
|
103
|
+
video_player_title_data_key_source: "other",
|
|
104
|
+
video_player_title_custom_data_key: "extensions.episode_name",
|
|
105
|
+
video_player_summary_data_key_source: "other",
|
|
106
|
+
video_player_summary_custom_data_key: "extensions.episode_subtitle",
|
|
107
|
+
},
|
|
108
|
+
dataKeys: VIDEO_PLAYER_CONTENT_DATA_KEYS,
|
|
109
|
+
})
|
|
110
|
+
).toEqual({
|
|
111
|
+
title: "Custom Episode",
|
|
112
|
+
summary: "Custom Subtitle",
|
|
113
|
+
});
|
|
114
|
+
});
|
|
115
|
+
|
|
116
|
+
it("ignores mobile custom data keys when dataKeys is VIDEO_PLAYER_CONTENT_DATA_KEYS", () => {
|
|
117
|
+
expect(
|
|
118
|
+
resolvePlayerTitleSubtitle({
|
|
119
|
+
entry,
|
|
120
|
+
pluginConfiguration: {
|
|
121
|
+
title_data_key_source: "other",
|
|
122
|
+
title_custom_data_key: "extensions.episode_name",
|
|
123
|
+
},
|
|
124
|
+
dataKeys: VIDEO_PLAYER_CONTENT_DATA_KEYS,
|
|
125
|
+
})
|
|
126
|
+
).toEqual({
|
|
127
|
+
title: "Default Title",
|
|
128
|
+
summary: "Default Summary",
|
|
129
|
+
});
|
|
130
|
+
});
|
|
131
|
+
|
|
132
|
+
it("produces a different resolved title than the default key set for the same configuration object", () => {
|
|
133
|
+
const pluginConfiguration = {
|
|
134
|
+
title_data_key_source: "other",
|
|
135
|
+
title_custom_data_key: "extensions.episode_name",
|
|
136
|
+
video_player_title_data_key_source: "other",
|
|
137
|
+
video_player_title_custom_data_key: "extensions.episode_subtitle",
|
|
138
|
+
};
|
|
139
|
+
|
|
140
|
+
const defaultResolved = resolvePlayerTitleSubtitle({
|
|
141
|
+
entry,
|
|
142
|
+
pluginConfiguration,
|
|
143
|
+
});
|
|
144
|
+
|
|
145
|
+
const tvResolved = resolvePlayerTitleSubtitle({
|
|
146
|
+
entry,
|
|
147
|
+
pluginConfiguration,
|
|
148
|
+
dataKeys: VIDEO_PLAYER_CONTENT_DATA_KEYS,
|
|
149
|
+
});
|
|
150
|
+
|
|
151
|
+
expect(defaultResolved.title).toBe("Custom Episode");
|
|
152
|
+
expect(tvResolved.title).toBe("Custom Subtitle");
|
|
153
|
+
expect(defaultResolved.title).not.toBe(tvResolved.title);
|
|
154
|
+
});
|
|
155
|
+
});
|
|
156
|
+
});
|
|
157
|
+
|
|
158
|
+
describe("getPlayerContentDataKeys", () => {
|
|
159
|
+
it("returns AUDIO_PLAYER_CONTENT_DATA_KEYS for TV audio content", () => {
|
|
160
|
+
expect(getPlayerContentDataKeys({ isTV: true, isAudioContent: true })).toBe(
|
|
161
|
+
AUDIO_PLAYER_CONTENT_DATA_KEYS
|
|
162
|
+
);
|
|
163
|
+
});
|
|
164
|
+
|
|
165
|
+
it("returns VIDEO_PLAYER_CONTENT_DATA_KEYS for TV video content", () => {
|
|
166
|
+
expect(
|
|
167
|
+
getPlayerContentDataKeys({ isTV: true, isAudioContent: false })
|
|
168
|
+
).toBe(VIDEO_PLAYER_CONTENT_DATA_KEYS);
|
|
169
|
+
});
|
|
170
|
+
|
|
171
|
+
it("returns undefined (the default/mobile key set) on mobile, regardless of content type", () => {
|
|
172
|
+
expect(
|
|
173
|
+
getPlayerContentDataKeys({ isTV: false, isAudioContent: true })
|
|
174
|
+
).toBeUndefined();
|
|
175
|
+
|
|
176
|
+
expect(
|
|
177
|
+
getPlayerContentDataKeys({ isTV: false, isAudioContent: false })
|
|
178
|
+
).toBeUndefined();
|
|
179
|
+
});
|
|
180
|
+
});
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
import { get } from "@applicaster/zapp-react-native-utils/utils";
|
|
2
|
+
import { isNotEmptyString } from "@applicaster/zapp-react-native-utils/stringUtils";
|
|
3
|
+
|
|
4
|
+
type GetValue = <T = string | number | null>(key: string) => T;
|
|
5
|
+
|
|
6
|
+
export type PlayerContentField = "title" | "subtitle";
|
|
7
|
+
|
|
8
|
+
const CUSTOM_SOURCE = "other";
|
|
9
|
+
|
|
10
|
+
const DEFAULT_ENTRY_PATH: Record<PlayerContentField, string> = {
|
|
11
|
+
title: "title",
|
|
12
|
+
subtitle: "summary",
|
|
13
|
+
};
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Configuration keys backing each field, exported so callers can build a
|
|
17
|
+
* stable configuration getter without duplicating the key strings.
|
|
18
|
+
*/
|
|
19
|
+
export const PLAYER_CONTENT_DATA_KEYS: Record<
|
|
20
|
+
PlayerContentField,
|
|
21
|
+
{ source: string; custom: string }
|
|
22
|
+
> = {
|
|
23
|
+
title: {
|
|
24
|
+
source: "title_data_key_source",
|
|
25
|
+
custom: "title_custom_data_key",
|
|
26
|
+
},
|
|
27
|
+
subtitle: {
|
|
28
|
+
source: "subtitle_data_key_source",
|
|
29
|
+
custom: "subtitle_custom_data_key",
|
|
30
|
+
},
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
export type PlayerContentDataKeys = Record<
|
|
34
|
+
PlayerContentField,
|
|
35
|
+
{ source: string; custom: string }
|
|
36
|
+
>;
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* TV keeps separate Title/Summary configuration per media type. Mobile has
|
|
40
|
+
* no equivalent split - it shares a single `PLAYER_CONTENT_DATA_KEYS` set
|
|
41
|
+
* for both video and audio - which is why these sets carry a media-type
|
|
42
|
+
* prefix (`video_player_*` / `audio_player_*`) and mobile's doesn't.
|
|
43
|
+
*/
|
|
44
|
+
export const VIDEO_PLAYER_CONTENT_DATA_KEYS: PlayerContentDataKeys = {
|
|
45
|
+
title: {
|
|
46
|
+
source: "video_player_title_data_key_source",
|
|
47
|
+
custom: "video_player_title_custom_data_key",
|
|
48
|
+
},
|
|
49
|
+
subtitle: {
|
|
50
|
+
source: "video_player_summary_data_key_source",
|
|
51
|
+
custom: "video_player_summary_custom_data_key",
|
|
52
|
+
},
|
|
53
|
+
};
|
|
54
|
+
|
|
55
|
+
export const AUDIO_PLAYER_CONTENT_DATA_KEYS: PlayerContentDataKeys = {
|
|
56
|
+
title: {
|
|
57
|
+
source: "audio_player_title_data_key_source",
|
|
58
|
+
custom: "audio_player_title_custom_data_key",
|
|
59
|
+
},
|
|
60
|
+
subtitle: {
|
|
61
|
+
source: "audio_player_summary_data_key_source",
|
|
62
|
+
custom: "audio_player_summary_custom_data_key",
|
|
63
|
+
},
|
|
64
|
+
};
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* Builds a GetValue over a plugin configuration object. Callers that hold a
|
|
68
|
+
* configuration rather than a `value` closure use this instead of hand-rolling
|
|
69
|
+
* the lookup.
|
|
70
|
+
*/
|
|
71
|
+
export const createConfigValueGetter =
|
|
72
|
+
(configuration: Option<Record<string, any>>): GetValue =>
|
|
73
|
+
<T>(key: string) =>
|
|
74
|
+
(configuration?.[key] ?? null) as T;
|
|
75
|
+
|
|
76
|
+
type ResolvePlayerContentTextParams = {
|
|
77
|
+
entry: Option<ZappEntry>;
|
|
78
|
+
field: PlayerContentField;
|
|
79
|
+
value: GetValue;
|
|
80
|
+
dataKeys?: PlayerContentDataKeys;
|
|
81
|
+
};
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* Resolves the text shown for the player's Title or Subtitle.
|
|
85
|
+
*
|
|
86
|
+
* Unless the customer explicitly selected the "Other" data key source and
|
|
87
|
+
* supplied a resolvable key, this returns the hardcoded entry field the
|
|
88
|
+
* player has always used, which keeps existing apps unchanged.
|
|
89
|
+
*/
|
|
90
|
+
export const resolvePlayerContentText = ({
|
|
91
|
+
entry,
|
|
92
|
+
field,
|
|
93
|
+
value,
|
|
94
|
+
dataKeys,
|
|
95
|
+
}: ResolvePlayerContentTextParams): Option<string | number> => {
|
|
96
|
+
if (!entry) {
|
|
97
|
+
return undefined;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
const defaultValue = get(entry, DEFAULT_ENTRY_PATH[field]);
|
|
101
|
+
|
|
102
|
+
const { source, custom } = (dataKeys ?? PLAYER_CONTENT_DATA_KEYS)[field];
|
|
103
|
+
|
|
104
|
+
if (value(source) !== CUSTOM_SOURCE) {
|
|
105
|
+
return defaultValue;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
const customKey = value<Option<string>>(custom);
|
|
109
|
+
|
|
110
|
+
// Only trim when the config value really is a string - it comes from
|
|
111
|
+
// free-text Studio configuration and can be a non-string (or null/undefined),
|
|
112
|
+
// and calling .trim() on that would throw.
|
|
113
|
+
const trimmedKey = isNotEmptyString(customKey) ? customKey.trim() : customKey;
|
|
114
|
+
|
|
115
|
+
if (!isNotEmptyString(trimmedKey)) {
|
|
116
|
+
return defaultValue;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
const customValue = get(entry, trimmedKey);
|
|
120
|
+
|
|
121
|
+
if (customValue === null || customValue === undefined || customValue === "") {
|
|
122
|
+
return defaultValue;
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
// The key is free text in the Studio, so it can easily land on an object or
|
|
126
|
+
// an array (`extensions.show` instead of `extensions.show.name`). Those
|
|
127
|
+
// reach <Text> untouched and throw "Objects are not valid as a React child",
|
|
128
|
+
// so they fall back like every other unusable key.
|
|
129
|
+
if (typeof customValue !== "string" && typeof customValue !== "number") {
|
|
130
|
+
return defaultValue;
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
return customValue;
|
|
134
|
+
};
|
package/playerUtils/index.ts
CHANGED
|
@@ -9,6 +9,26 @@ import { Dimensions } from "react-native";
|
|
|
9
9
|
|
|
10
10
|
export { getPlayerActionButtons } from "./getPlayerActionButtons";
|
|
11
11
|
|
|
12
|
+
export {
|
|
13
|
+
resolvePlayerContentText,
|
|
14
|
+
PLAYER_CONTENT_DATA_KEYS,
|
|
15
|
+
VIDEO_PLAYER_CONTENT_DATA_KEYS,
|
|
16
|
+
AUDIO_PLAYER_CONTENT_DATA_KEYS,
|
|
17
|
+
createConfigValueGetter,
|
|
18
|
+
} from "./contentDataKeys";
|
|
19
|
+
|
|
20
|
+
export type {
|
|
21
|
+
PlayerContentField,
|
|
22
|
+
PlayerContentDataKeys,
|
|
23
|
+
} from "./contentDataKeys";
|
|
24
|
+
|
|
25
|
+
export {
|
|
26
|
+
resolvePlayerTitleSubtitle,
|
|
27
|
+
getPlayerContentDataKeys,
|
|
28
|
+
} from "./resolvePlayerTitleSubtitle";
|
|
29
|
+
|
|
30
|
+
export { isAudioItem } from "./isAudioItem";
|
|
31
|
+
|
|
12
32
|
export const HLS_MIME_TYPES = [
|
|
13
33
|
"application/x-mpegURL",
|
|
14
34
|
"application/vnd.apple.mpegurl",
|
|
@@ -102,21 +122,6 @@ export const isVideoItem = (item: Option<ZappEntry>) => {
|
|
|
102
122
|
);
|
|
103
123
|
};
|
|
104
124
|
|
|
105
|
-
export const isAudioItem = (item: Option<ZappEntry>) => {
|
|
106
|
-
if (
|
|
107
|
-
isString(item?.content?.type) &&
|
|
108
|
-
item?.content?.type?.includes?.("audio")
|
|
109
|
-
) {
|
|
110
|
-
return true;
|
|
111
|
-
}
|
|
112
|
-
|
|
113
|
-
if (isString(item?.type?.value) && item?.type?.value?.includes?.("audio")) {
|
|
114
|
-
return true;
|
|
115
|
-
}
|
|
116
|
-
|
|
117
|
-
return false;
|
|
118
|
-
};
|
|
119
|
-
|
|
120
125
|
export const isInlineTV = (screenData) => {
|
|
121
126
|
return isTV() && isFilledArray(screenData?.ui_components);
|
|
122
127
|
};
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { isString } from "@applicaster/zapp-react-native-utils/typeGuards";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Lives in its own module rather than in `playerUtils/index.ts` because that
|
|
5
|
+
* barrel imports `playerManager`, and files inside `appUtils/playerManager/`
|
|
6
|
+
* need this helper. Importing it from the barrel there would create a require
|
|
7
|
+
* cycle:
|
|
8
|
+
*
|
|
9
|
+
* playerManager/index -> player -> playerUtils/index -> playerManager/index
|
|
10
|
+
*
|
|
11
|
+
* Re-exported from the barrel, so existing importers are unaffected.
|
|
12
|
+
*/
|
|
13
|
+
export const isAudioItem = (item: Option<ZappEntry>) => {
|
|
14
|
+
if (
|
|
15
|
+
isString(item?.content?.type) &&
|
|
16
|
+
item?.content?.type?.includes?.("audio")
|
|
17
|
+
) {
|
|
18
|
+
return true;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
if (isString(item?.type?.value) && item?.type?.value?.includes?.("audio")) {
|
|
22
|
+
return true;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
return false;
|
|
26
|
+
};
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import {
|
|
2
|
+
createConfigValueGetter,
|
|
3
|
+
resolvePlayerContentText,
|
|
4
|
+
VIDEO_PLAYER_CONTENT_DATA_KEYS,
|
|
5
|
+
AUDIO_PLAYER_CONTENT_DATA_KEYS,
|
|
6
|
+
} from "./contentDataKeys";
|
|
7
|
+
import type { PlayerContentDataKeys } from "./contentDataKeys";
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Resolves the player's Title/Subtitle text as raw values (string | number |
|
|
11
|
+
* null). Called by `Player.getContent()`, which publishes the result on the
|
|
12
|
+
* player's content channel; every consumer - the mobile/TV transport
|
|
13
|
+
* controls, `ProgramInfo`, the TV audio player, the Chromecast controller and
|
|
14
|
+
* the native bridge - reads it from there rather than resolving for itself.
|
|
15
|
+
*
|
|
16
|
+
* `dataKeys` selects which Studio-configured key set backs the resolution:
|
|
17
|
+
* omit it for the default (mobile) `PLAYER_CONTENT_DATA_KEYS` set, or pass
|
|
18
|
+
* an explicit set (e.g. `VIDEO_PLAYER_CONTENT_DATA_KEYS`) for platforms/content
|
|
19
|
+
* types that keep separate Studio configuration for this text. Getting the
|
|
20
|
+
* key set backwards would make one platform read another platform's
|
|
21
|
+
* configuration, so every caller must be explicit about which set it wants.
|
|
22
|
+
*
|
|
23
|
+
* Keeping this in one place is what stops the dot-path / key-set resolution
|
|
24
|
+
* logic (`resolvePlayerContentText`) from being duplicated per caller.
|
|
25
|
+
*/
|
|
26
|
+
export const resolvePlayerTitleSubtitle = ({
|
|
27
|
+
entry,
|
|
28
|
+
pluginConfiguration,
|
|
29
|
+
dataKeys,
|
|
30
|
+
}: {
|
|
31
|
+
entry: Option<ZappEntry>;
|
|
32
|
+
pluginConfiguration: Option<Record<string, any>>;
|
|
33
|
+
dataKeys?: PlayerContentDataKeys;
|
|
34
|
+
}): {
|
|
35
|
+
title: Option<string | number>;
|
|
36
|
+
summary: Option<string | number>;
|
|
37
|
+
} => {
|
|
38
|
+
const value = createConfigValueGetter(pluginConfiguration);
|
|
39
|
+
|
|
40
|
+
const title =
|
|
41
|
+
resolvePlayerContentText({ entry, field: "title", value, dataKeys }) ??
|
|
42
|
+
null;
|
|
43
|
+
|
|
44
|
+
const summary =
|
|
45
|
+
resolvePlayerContentText({
|
|
46
|
+
entry,
|
|
47
|
+
field: "subtitle",
|
|
48
|
+
value,
|
|
49
|
+
dataKeys,
|
|
50
|
+
}) ?? null;
|
|
51
|
+
|
|
52
|
+
return { title, summary };
|
|
53
|
+
};
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Picks which Studio-configured key set backs a Title/Subtitle resolution,
|
|
57
|
+
* from the full three-way choice: TV audio, TV video, or mobile. Each of
|
|
58
|
+
* those ships separate Studio configuration for this text; getting this
|
|
59
|
+
* backwards would make one platform (or content type) read another's
|
|
60
|
+
* configuration.
|
|
61
|
+
*/
|
|
62
|
+
export const getPlayerContentDataKeys = ({
|
|
63
|
+
isTV,
|
|
64
|
+
isAudioContent,
|
|
65
|
+
}: {
|
|
66
|
+
isTV: boolean;
|
|
67
|
+
isAudioContent: boolean;
|
|
68
|
+
}): PlayerContentDataKeys | undefined => {
|
|
69
|
+
if (!isTV) {
|
|
70
|
+
return undefined;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
return isAudioContent
|
|
74
|
+
? AUDIO_PLAYER_CONTENT_DATA_KEYS
|
|
75
|
+
: VIDEO_PLAYER_CONTENT_DATA_KEYS;
|
|
76
|
+
};
|
|
@@ -1,8 +1,12 @@
|
|
|
1
1
|
/// <reference types="@applicaster/applicaster-types" />
|
|
2
2
|
/* eslint-disable @typescript-eslint/no-unused-vars */
|
|
3
|
-
import { Context, useContext, useState } from "react";
|
|
3
|
+
import { Context, useCallback, useContext, useEffect, useState } from "react";
|
|
4
4
|
import { ActionsContext } from "@applicaster/zapp-react-native-ui-components/Contexts/ActionsContext";
|
|
5
5
|
|
|
6
|
+
import {
|
|
7
|
+
observeEntryState,
|
|
8
|
+
RegisteredActionValue,
|
|
9
|
+
} from "../../uiActionsRegistrator";
|
|
6
10
|
import { reactHooksLogger } from "../logger";
|
|
7
11
|
|
|
8
12
|
const logger = reactHooksLogger.addSubsystem("actions");
|
|
@@ -46,3 +50,49 @@ export function useActions<T = unknown>(plugId: string): any {
|
|
|
46
50
|
|
|
47
51
|
return context;
|
|
48
52
|
}
|
|
53
|
+
|
|
54
|
+
export type UseEntryActionState = {
|
|
55
|
+
state: CellActionEntryState | undefined;
|
|
56
|
+
invokeAction: (options?: InvokeArgsOptions) => void;
|
|
57
|
+
};
|
|
58
|
+
|
|
59
|
+
/**
|
|
60
|
+
* Subscribes a component to a single action's state for a given `entry`.
|
|
61
|
+
*
|
|
62
|
+
* It observes state changes reactively via `observeEntryState` (which is backed
|
|
63
|
+
* by the action's `addListener`), seeds the initial value synchronously from
|
|
64
|
+
* `initialEntryState`, and returns a memoized `invokeAction` that forwards
|
|
65
|
+
* optimistic `updateState` updates back into local state.
|
|
66
|
+
*
|
|
67
|
+
* This is the single, unified way to drive an action button - it works the same
|
|
68
|
+
* for registry actions, legacy context-provider actions and entry actions.
|
|
69
|
+
*/
|
|
70
|
+
export function useEntryActionState(
|
|
71
|
+
action: RegisteredActionValue | undefined,
|
|
72
|
+
entry: ZappEntry | ZappFeed
|
|
73
|
+
): UseEntryActionState {
|
|
74
|
+
const [state, setState] = useState<CellActionEntryState | undefined>(() =>
|
|
75
|
+
action?.initialEntryState?.(entry)
|
|
76
|
+
);
|
|
77
|
+
|
|
78
|
+
const entryId = (entry as ZappEntry)?.id;
|
|
79
|
+
|
|
80
|
+
useEffect(() => {
|
|
81
|
+
if (!action) return undefined;
|
|
82
|
+
|
|
83
|
+
const subscription = observeEntryState(action, entry).subscribe(setState);
|
|
84
|
+
|
|
85
|
+
return () => subscription.unsubscribe();
|
|
86
|
+
// eslint-disable-next-line @wogns3623/better-exhaustive-deps/exhaustive-deps
|
|
87
|
+
}, [action, entryId]);
|
|
88
|
+
|
|
89
|
+
const invokeAction = useCallback(
|
|
90
|
+
(options: InvokeArgsOptions = {}) => {
|
|
91
|
+
action?.invokeAction?.(entry, { updateState: setState, ...options });
|
|
92
|
+
},
|
|
93
|
+
// eslint-disable-next-line @wogns3623/better-exhaustive-deps/exhaustive-deps
|
|
94
|
+
[action, entryId]
|
|
95
|
+
);
|
|
96
|
+
|
|
97
|
+
return { state, invokeAction };
|
|
98
|
+
}
|
|
@@ -4,6 +4,7 @@ import * as React from "react";
|
|
|
4
4
|
import * as R from "ramda";
|
|
5
5
|
import { handleActionSchemeUrl } from "@applicaster/quick-brick-core/App/DeepLinking/URLSchemeHandler/SchemeHandlerHooks/useUrlSchemeHandler";
|
|
6
6
|
import { CellTapContext } from "@applicaster/zapp-react-native-ui-components/Contexts/CellTapContext";
|
|
7
|
+
import { useUIComponentContext } from "@applicaster/zapp-react-native-ui-components/Contexts/UIComponentContext";
|
|
7
8
|
import {
|
|
8
9
|
useNavigation,
|
|
9
10
|
useProfilerLogging,
|
|
@@ -28,7 +29,6 @@ import { useScreenStateStore } from "../navigation/useScreenStateStore";
|
|
|
28
29
|
type Props = {
|
|
29
30
|
item?: ZappEntry;
|
|
30
31
|
index?: number;
|
|
31
|
-
component?: ZappUIComponent;
|
|
32
32
|
zappPipesData?: ZappPipesData;
|
|
33
33
|
};
|
|
34
34
|
|
|
@@ -37,16 +37,16 @@ type onPressReturnFn =
|
|
|
37
37
|
| (() => void);
|
|
38
38
|
|
|
39
39
|
export const useCellClick = ({
|
|
40
|
-
component,
|
|
41
40
|
zappPipesData,
|
|
42
41
|
item,
|
|
43
|
-
}: Props): onPressReturnFn => {
|
|
42
|
+
}: Props = {}): onPressReturnFn => {
|
|
44
43
|
const { push, currentRoute } = useNavigation();
|
|
45
44
|
const { pathname } = useRoute();
|
|
46
45
|
const screenStateStore = useScreenStateStore();
|
|
47
46
|
|
|
48
47
|
const onCellTap: Option<Function> = React.useContext(CellTapContext);
|
|
49
48
|
const actionExecutor = React.useContext(ActionExecutorContext);
|
|
49
|
+
const component = useUIComponentContext();
|
|
50
50
|
const screenData = useCurrentScreenData();
|
|
51
51
|
const screenState = useScreenContext()?.options;
|
|
52
52
|
const entry = useScreenContext()?.entry;
|
|
@@ -242,4 +242,29 @@ describe("useGetUrlInflater", () => {
|
|
|
242
242
|
const url = result.current(source, mapping);
|
|
243
243
|
expect(url).toBe("https://foo.com/shows/A123?q=user%20query");
|
|
244
244
|
});
|
|
245
|
+
|
|
246
|
+
it("handles search queries with apostrophes without HTML entity escaping or URL truncation", () => {
|
|
247
|
+
const source =
|
|
248
|
+
"https://api.pc-cms.tele.quebec/api/applicaster/v1/mobile/search?q={{q}}";
|
|
249
|
+
|
|
250
|
+
const mapping = {
|
|
251
|
+
q: { source: "search", property: "q" },
|
|
252
|
+
};
|
|
253
|
+
|
|
254
|
+
const searchContext = getSearchContext("L'aventure", mapping);
|
|
255
|
+
|
|
256
|
+
const result = getInflatedDataSourceUrl({
|
|
257
|
+
source,
|
|
258
|
+
contexts: {
|
|
259
|
+
search: searchContext,
|
|
260
|
+
},
|
|
261
|
+
mapping,
|
|
262
|
+
});
|
|
263
|
+
|
|
264
|
+
expect(result).toBe(
|
|
265
|
+
"https://api.pc-cms.tele.quebec/api/applicaster/v1/mobile/search?q=L'aventure"
|
|
266
|
+
);
|
|
267
|
+
|
|
268
|
+
expect(result).not.toContain("'");
|
|
269
|
+
});
|
|
245
270
|
});
|
package/reactHooks/feed/index.ts
CHANGED
|
@@ -6,7 +6,11 @@ export { useEntryScreenId } from "./useEntryScreenId";
|
|
|
6
6
|
|
|
7
7
|
export { useBuildPipesUrl } from "./useBuildPipesUrl";
|
|
8
8
|
|
|
9
|
-
export {
|
|
9
|
+
export {
|
|
10
|
+
useMarkPipesDataStale,
|
|
11
|
+
// eslint-disable-next-line @typescript-eslint/no-deprecated
|
|
12
|
+
usePipesCacheReset,
|
|
13
|
+
} from "./useMarkPipesDataStale";
|
|
10
14
|
|
|
11
15
|
export { useBatchLoading } from "./useBatchLoading";
|
|
12
16
|
|
|
@@ -159,9 +159,17 @@ export const useBatchLoading = (
|
|
|
159
159
|
options.riverId,
|
|
160
160
|
]);
|
|
161
161
|
|
|
162
|
+
// Initial preload only. Batch loading warms the first batch of component
|
|
163
|
+
// feeds and signals readiness; the feed set is frozen at mount on purpose.
|
|
164
|
+
// Per-component loads and reloads (including stale revalidation) are owned by
|
|
165
|
+
// useFeedLoader in ZappPipesDataConnector. Re-running on `feeds`/input changes
|
|
166
|
+
// would re-fire on every store update and cause redundant dispatch storms, so
|
|
167
|
+
// this intentionally runs once on mount.
|
|
168
|
+
/* eslint-disable @wogns3623/better-exhaustive-deps/exhaustive-deps */
|
|
162
169
|
React.useEffect(() => {
|
|
163
170
|
runBatchLoading();
|
|
164
|
-
}, [
|
|
171
|
+
}, []);
|
|
172
|
+
/* eslint-enable @wogns3623/better-exhaustive-deps/exhaustive-deps */
|
|
165
173
|
|
|
166
174
|
React.useEffect(() => {
|
|
167
175
|
// check if all feeds are ready and set hasEverBeenReady to true
|
|
@@ -2,17 +2,19 @@ import React from "react";
|
|
|
2
2
|
|
|
3
3
|
import { getDatasourceUrl } from "@applicaster/zapp-react-native-ui-components/Decorators/RiverFeedLoader/utils/getDatasourceUrl";
|
|
4
4
|
import { usePipesContexts } from "@applicaster/zapp-react-native-ui-components/Decorators/RiverFeedLoader/utils/usePipesContexts";
|
|
5
|
-
import {
|
|
5
|
+
import { markPipesDataStale } from "@applicaster/zapp-react-native-redux/ZappPipes";
|
|
6
6
|
|
|
7
7
|
import { useRoute } from "../navigation";
|
|
8
8
|
import { useAppDispatch } from "@applicaster/zapp-react-native-redux";
|
|
9
9
|
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
11
|
+
* Mark a river's `clear_cache_on_reload` feeds as stale when the screen is
|
|
12
|
+
* unmounted. The cached data is kept (so a screen sharing the same feed does
|
|
13
|
+
* not lose it mid-mount) and revalidated on next access.
|
|
12
14
|
* @param {string} riverId screen id
|
|
13
15
|
* @param {Array} riverComponents list of UI components
|
|
14
16
|
*/
|
|
15
|
-
export const
|
|
17
|
+
export const useMarkPipesDataStale = (riverId, riverComponents) => {
|
|
16
18
|
const dispatch = useAppDispatch();
|
|
17
19
|
const { screenData, pathname } = useRoute();
|
|
18
20
|
const pipesContexts = usePipesContexts(riverId, pathname);
|
|
@@ -35,10 +37,16 @@ export const usePipesCacheReset = (riverId, riverComponents) => {
|
|
|
35
37
|
);
|
|
36
38
|
|
|
37
39
|
if (url) {
|
|
38
|
-
dispatch(
|
|
40
|
+
dispatch(markPipesDataStale(url, { riverId }));
|
|
39
41
|
}
|
|
40
42
|
}
|
|
41
43
|
});
|
|
42
44
|
};
|
|
43
45
|
}, []);
|
|
44
46
|
};
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* @deprecated Renamed to `useMarkPipesDataStale`. Kept as an alias for backward
|
|
50
|
+
* compatibility with external consumers.
|
|
51
|
+
*/
|
|
52
|
+
export const usePipesCacheReset = useMarkPipesDataStale;
|