@netless/fastboard-core 0.3.6 → 1.0.0-canary.2

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.
@@ -1,251 +0,0 @@
1
- import type { MountParams, NetlessApp, PublicEvent } from "@netless/window-manager";
2
- import type {
3
- Player,
4
- PlayerPhase as PlayerPhaseEnum,
5
- PlayerCallbacks,
6
- PlayerState,
7
- PlayerSeekingResult,
8
- ReplayRoomParams,
9
- ViewCallbacks,
10
- WhiteWebSdkConfiguration,
11
- } from "white-web-sdk";
12
- import type { SyncedStore } from "@netless/synced-store";
13
-
14
- import { WhiteWebSdk } from "white-web-sdk";
15
- import { WindowManager } from "@netless/window-manager";
16
- import { SyncedStorePlugin } from "@netless/synced-store";
17
- import { readable, writable } from "../utils";
18
- import { ensure_official_plugins } from "../internal";
19
- import { register } from "../behaviors";
20
-
21
- class FastboardPlayerBase<TEventData = any> {
22
- public constructor(
23
- readonly sdk: WhiteWebSdk,
24
- readonly player: Player,
25
- readonly manager: WindowManager,
26
- readonly syncedStore: SyncedStore<TEventData>
27
- ) {}
28
-
29
- protected _destroyed = false;
30
- protected _assertNotDestroyed() {
31
- if (this._destroyed) {
32
- throw new Error("FastboardApp has been destroyed");
33
- }
34
- }
35
-
36
- protected _addPlayerListener<K extends keyof PlayerCallbacks>(name: K, listener: PlayerCallbacks[K]) {
37
- this._assertNotDestroyed();
38
- this.player.callbacks.on(name, listener);
39
- return () => this.player.callbacks.off(name, listener);
40
- }
41
-
42
- protected _addManagerListener<K extends keyof PublicEvent>(
43
- name: K,
44
- listener: (value: PublicEvent[K]) => void
45
- ) {
46
- this._assertNotDestroyed();
47
- this.manager.emitter.on(name, listener);
48
- return () => this.manager.emitter.off(name, listener);
49
- }
50
-
51
- protected _addMainViewListener<K extends keyof ViewCallbacks>(name: K, listener: ViewCallbacks[K]) {
52
- this._assertNotDestroyed();
53
- this.manager.mainView.callbacks.on(name, listener);
54
- return () => this.manager.mainView.callbacks.off(name, listener);
55
- }
56
-
57
- public destroy() {
58
- this._destroyed = true;
59
- this.manager.destroy();
60
- return this.player.callbacks.off();
61
- }
62
- }
63
-
64
- type PlayerPhase = `${PlayerPhaseEnum}`;
65
-
66
- export type { PlayerPhase, PlayerSeekingResult };
67
-
68
- export class FastboardPlayer<TEventData = any> extends FastboardPlayerBase<TEventData> {
69
- /**
70
- * Render this player to some DOM.
71
- */
72
- bindContainer(container: HTMLElement) {
73
- this._assertNotDestroyed();
74
- this.manager.bindContainer(container);
75
- }
76
-
77
- /**
78
- * Move window-manager's collector to some place.
79
- */
80
- bindCollector(container: HTMLElement) {
81
- this._assertNotDestroyed();
82
- this.manager.bindCollectorContainer(container);
83
- }
84
-
85
- /**
86
- * Player current time in milliseconds.
87
- */
88
- readonly currentTime = writable(
89
- this.player.progressTime,
90
- set => {
91
- set(this.player.progressTime);
92
- return this._addPlayerListener("onProgressTimeChanged", set);
93
- },
94
- this.player.seekToProgressTime.bind(this.player)
95
- );
96
-
97
- /**
98
- * Player state, like "is it playing?".
99
- */
100
- readonly phase = readable<PlayerPhase>(this.player.phase, set => {
101
- set(this.player.phase);
102
- return this._addPlayerListener("onPhaseChanged", set);
103
- });
104
-
105
- /**
106
- * Will become true after buffering.
107
- */
108
- readonly canplay = readable(this.player.isPlayable, set => {
109
- set(this.player.isPlayable);
110
- return this._addPlayerListener("onIsPlayableChanged", set);
111
- });
112
-
113
- private _setPlaybackRate!: (value: number) => void;
114
- /**
115
- * Playback speed, default `1`.
116
- */
117
- readonly playbackRate = writable(
118
- this.player.playbackSpeed,
119
- set => {
120
- this._setPlaybackRate = set;
121
- set(this.player.playbackSpeed);
122
- },
123
- value => {
124
- this.player.playbackSpeed = value;
125
- this._setPlaybackRate(value);
126
- }
127
- );
128
-
129
- /**
130
- * Playback duration in milliseconds.
131
- */
132
- readonly duration = readable(this.player.timeDuration, set => {
133
- set(this.player.timeDuration);
134
- });
135
-
136
- /**
137
- * Get state of room at that time, like "who was in the room?".
138
- */
139
- readonly state = readable<PlayerState>(this.player.state, set => {
140
- set(this.player.state);
141
- return this._addPlayerListener("onPlayerStateChanged", () => set(this.player.state));
142
- });
143
-
144
- /**
145
- * Seek to some time in milliseconds.
146
- */
147
- seek(timestamp: number) {
148
- this._assertNotDestroyed();
149
- return this.player.seekToProgressTime(timestamp);
150
- }
151
-
152
- /**
153
- * Change player state to playing.
154
- */
155
- play() {
156
- this._assertNotDestroyed();
157
- this.player.play();
158
- }
159
-
160
- /**
161
- * Change player state to paused.
162
- */
163
- pause() {
164
- this._assertNotDestroyed();
165
- this.player.pause();
166
- }
167
-
168
- /**
169
- * Change player state to stopped.
170
- */
171
- stop() {
172
- this._assertNotDestroyed();
173
- this.player.stop();
174
- }
175
-
176
- /**
177
- * Set playback speed, a shortcut for `speed.set(x)`.
178
- */
179
- setPlaybackRate(value: number) {
180
- this._assertNotDestroyed();
181
- this.playbackRate.set(value);
182
- }
183
- }
184
-
185
- export interface FastboardReplayOptions {
186
- sdkConfig: Omit<WhiteWebSdkConfiguration, "useMobXState"> & {
187
- region: NonNullable<WhiteWebSdkConfiguration["region"]>;
188
- };
189
- replayRoom: Omit<ReplayRoomParams, "useMultiViews"> & {
190
- callbacks?: Partial<PlayerCallbacks>;
191
- };
192
- managerConfig?: Omit<MountParams, "room">;
193
- netlessApps?: NetlessApp[];
194
- }
195
-
196
- /**
197
- * Create a FastboardPlayer instance.
198
- * @example
199
- * let player = await replayFastboard({
200
- * sdkConfig: {
201
- * appIdentifier: import.meta.env.VITE_APPID,
202
- * region: 'cn-hz',
203
- * },
204
- * replayRoom: {
205
- * room: "room uuid",
206
- * roomToken: "NETLESSROOM_...",
207
- * beginTimestamp: 1646619090394,
208
- * duration: 70448,
209
- * },
210
- * })
211
- */
212
- export async function replayFastboard<TEventData = any>({
213
- sdkConfig,
214
- replayRoom: { callbacks, ...replayRoomParams },
215
- managerConfig,
216
- netlessApps,
217
- }: FastboardReplayOptions) {
218
- const sdk = new WhiteWebSdk({
219
- ...sdkConfig,
220
- useMobXState: true,
221
- });
222
-
223
- if (netlessApps) {
224
- netlessApps.forEach(app => {
225
- register({ kind: app.kind, src: app });
226
- });
227
- }
228
-
229
- const player = await sdk.replayRoom(
230
- {
231
- ...ensure_official_plugins(replayRoomParams),
232
- useMultiViews: true,
233
- },
234
- callbacks
235
- );
236
-
237
- const syncedStore = await SyncedStorePlugin.init<TEventData>(player);
238
-
239
- const managerPromise = WindowManager.mount({
240
- cursor: true,
241
- ...managerConfig,
242
- room: player,
243
- });
244
-
245
- player.play();
246
- const manager = await managerPromise;
247
- player.pause();
248
- await player.seekToProgressTime(0);
249
-
250
- return new FastboardPlayer<TEventData>(sdk, player, manager, syncedStore);
251
- }
package/src/impl/index.ts DELETED
@@ -1,2 +0,0 @@
1
- export * from "./FastboardApp";
2
- export * from "./FastboardPlayer";
package/src/internal.ts DELETED
@@ -1,16 +0,0 @@
1
- import type { JoinRoomParams, ReplayRoomParams } from "white-web-sdk";
2
- import type { PublicEvent } from "@netless/window-manager";
3
- import { WindowManager } from "@netless/window-manager";
4
- import { SyncedStorePlugin } from "@netless/synced-store";
5
-
6
- export function ensure_official_plugins<T extends JoinRoomParams | ReplayRoomParams>(joinRoom: T): T {
7
- const plugins = new Set(joinRoom.invisiblePlugins || []);
8
- plugins.add(WindowManager);
9
- plugins.add(SyncedStorePlugin);
10
- joinRoom.invisiblePlugins = [...plugins];
11
- return joinRoom;
12
- }
13
-
14
- export function transform_app_status(status: PublicEvent["loadApp"]["status"]) {
15
- return status === "start" ? "loading" : status === "failed" ? "failed" : "idle";
16
- }
@@ -1,4 +0,0 @@
1
- export * from "./store";
2
- export * from "./misc";
3
- export * from "./uid";
4
- export * from "./warn";
package/src/utils/misc.ts DELETED
@@ -1,49 +0,0 @@
1
- import type { ConvertedFile, SceneDefinition, Size } from "white-web-sdk";
2
-
3
- export function getImageSize(url: string, fallback: Size) {
4
- return new Promise<Size>(resolve => {
5
- const img = new Image();
6
- img.onload = () => resolve(img);
7
- img.onerror = () => resolve(fallback);
8
- img.src = url;
9
- });
10
- }
11
-
12
- export function makeSlideParams(scenes: SceneDefinition[]) {
13
- const emptyScenes: SceneDefinition[] = [];
14
- let taskId = "";
15
- let url = "";
16
-
17
- // e.g. "ppt(x)://cdn/prefix/dynamicConvert/{taskId}/1.slide"
18
- const pptSrcRE = /^pptx?(?<prefix>:\/\/\S+?dynamicConvert)\/(?<taskId>\w+)\//;
19
-
20
- for (const { name, ppt } of scenes) {
21
- // make sure scenesWithoutPPT.length === scenes.length
22
- emptyScenes.push({ name });
23
-
24
- if (!ppt || !ppt.src.startsWith("ppt")) {
25
- continue;
26
- }
27
- const match = pptSrcRE.exec(ppt.src);
28
- if (!match || !match.groups) {
29
- continue;
30
- }
31
- taskId = match.groups.taskId;
32
- url = "https" + match.groups.prefix;
33
- break;
34
- }
35
-
36
- return { scenes: emptyScenes, taskId, url };
37
- }
38
-
39
- export function convertedFileToScene(f: ConvertedFile, i: number): SceneDefinition {
40
- return {
41
- name: String(i + 1),
42
- ppt: {
43
- src: f.conversionFileUrl,
44
- width: f.width,
45
- height: f.height,
46
- previewURL: f.preview,
47
- },
48
- };
49
- }
@@ -1,87 +0,0 @@
1
- // This is a simple mimic of svelte/store.
2
- export type Subscriber<T> = (value: T) => void;
3
- export type Unsubscriber = () => void;
4
- export type Updater<T> = (value: T) => T;
5
- export type StartStopNotifier<T> = (set: Subscriber<T>) => Unsubscriber | void;
6
-
7
- export interface Readable<T> {
8
- readonly value: T;
9
- subscribe(this: void, run: Subscriber<T>): Unsubscriber;
10
- reaction(this: void, run: Subscriber<T>): Unsubscriber;
11
- }
12
-
13
- export interface Writable<T> extends Readable<T> {
14
- set(this: void, value: T): void;
15
- update(this: void, updater: Updater<T>): void;
16
- }
17
-
18
- // eslint-disable-next-line @typescript-eslint/no-empty-function
19
- function noop() {}
20
-
21
- function safe_not_equal(a: unknown, b: unknown) {
22
- return a != a ? b == b : a !== b || (a && typeof a === "object") || typeof a === "function";
23
- }
24
-
25
- export function readable<T>(value: T, start: StartStopNotifier<T> = noop): Readable<T> {
26
- let stop: Unsubscriber | undefined;
27
- const subscribers = new Set<Subscriber<T>>();
28
- function set(new_value: T) {
29
- if (safe_not_equal(value, new_value)) {
30
- value = new_value;
31
- if (stop) {
32
- for (const run of subscribers) {
33
- run(value);
34
- }
35
- }
36
- }
37
- }
38
- function subscribe(run: Subscriber<T>) {
39
- subscribers.add(run);
40
- if (subscribers.size === 1) {
41
- stop = start(set) || noop;
42
- }
43
- run(value);
44
- return () => {
45
- subscribers.delete(run);
46
- if (subscribers.size === 0) {
47
- stop && stop();
48
- stop = undefined;
49
- }
50
- };
51
- }
52
- function reaction(run: Subscriber<T>) {
53
- subscribers.add(run);
54
- if (subscribers.size === 1) {
55
- stop = start(set) || noop;
56
- }
57
- return () => {
58
- subscribers.delete(run);
59
- if (subscribers.size === 0) {
60
- stop && stop();
61
- stop = undefined;
62
- }
63
- };
64
- }
65
- return {
66
- get value() {
67
- return value;
68
- },
69
- subscribe,
70
- reaction,
71
- };
72
- }
73
-
74
- export function writable<T>(value: T, start: StartStopNotifier<T> = noop, set: Subscriber<T>): Writable<T> {
75
- const internal = readable(value, start);
76
- return {
77
- get value() {
78
- return internal.value;
79
- },
80
- subscribe: internal.subscribe,
81
- reaction: internal.reaction,
82
- set,
83
- update(fn: Updater<T>) {
84
- set(fn(value));
85
- },
86
- };
87
- }
package/src/utils/uid.ts DELETED
@@ -1,12 +0,0 @@
1
- // Copy from https://github.com/crimx/side-effect-manager/blob/main/src/gen-uid.ts
2
- const SOUP = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
3
- const SOUP_LEN = 62; // SOUP.length
4
- const ID_LEN = 20;
5
- const reusedIdCarrier = /* @__PURE__ */ Array(ID_LEN);
6
-
7
- export function genUID() {
8
- for (let i = 0; i < ID_LEN; i++) {
9
- reusedIdCarrier[i] = SOUP.charAt(Math.random() * SOUP_LEN);
10
- }
11
- return reusedIdCarrier.join("");
12
- }
package/src/utils/warn.ts DELETED
@@ -1,11 +0,0 @@
1
- const warnings = {
2
- "no-ppt-in-scenes":
3
- "You're probably inserting the slide app in a wrong way, there shouldn't exist `scenes[0].ppt`.",
4
- } as const;
5
- const warned = new Set<string>();
6
-
7
- export function warn(id: keyof typeof warnings) {
8
- if (warned.has(id)) return;
9
- warned.add(id);
10
- console.warn(warnings[id]);
11
- }