-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathuseRiveFile.ts
More file actions
176 lines (153 loc) · 4.73 KB
/
useRiveFile.ts
File metadata and controls
176 lines (153 loc) · 4.73 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
import { useState, useEffect, useMemo, useRef } from 'react';
import { Image } from 'react-native';
import { RiveFileFactory } from '../core/RiveFile';
import type {
RiveFile,
ResolvedReferencedAsset,
} from '../specs/RiveFile.nitro';
import type {
ReferencedAsset,
ReferencedAssets,
ResolvedReferencedAssets,
} from '../core/ReferencedAssets';
export type { ReferencedAssets, ResolvedReferencedAssets };
export type RiveFileInput = number | { uri: string } | string | ArrayBuffer;
export type UseRiveFileOptions = {
referencedAssets?: ReferencedAssets;
};
function parsePossibleSources(
source: ReferencedAsset['source']
): ResolvedReferencedAsset {
if (typeof source === 'number') {
const resolvedAsset = Image.resolveAssetSource(source);
if (resolvedAsset && resolvedAsset.uri) {
return { sourceAssetId: resolvedAsset.uri };
} else {
throw new Error('Invalid asset source provided.');
}
}
const uri = (source as any).uri;
if (typeof source === 'object' && uri) {
return { sourceUrl: uri };
}
const asset = (source as any).fileName;
const path = (source as any).path;
if (typeof source === 'object' && asset) {
const result: ResolvedReferencedAsset = { sourceAsset: asset };
if (path) {
result.path = path;
}
return result;
}
throw new Error('Invalid source provided.');
}
function transformFilesHandledMapping(
mapping?: ReferencedAssets
): ResolvedReferencedAssets | undefined {
const transformedMapping: ResolvedReferencedAssets = {};
if (mapping === undefined) {
return undefined;
}
Object.entries(mapping).forEach(([key, option]) => {
transformedMapping[key] = parsePossibleSources(option.source);
});
return transformedMapping;
}
type RiveFileHookResult =
| { riveFile: RiveFile; isLoading: false; error: null }
| { riveFile: null; isLoading: true; error: null }
| { riveFile: null; isLoading: false; error: string };
export function useRiveFile(
input: RiveFileInput | undefined,
options: UseRiveFileOptions = {}
): RiveFileHookResult {
const [result, setResult] = useState<RiveFileHookResult>({
riveFile: null,
isLoading: true,
error: null,
});
const referencedAssets = useMemo(
() => transformFilesHandledMapping(options.referencedAssets),
[options.referencedAssets]
);
const initialReferencedAssets = useRef(referencedAssets);
const initialInput = useRef(input);
useEffect(() => {
let currentFile: RiveFile | null = null;
const loadRiveFile = async () => {
try {
const currentInput = input;
if (currentInput == null) {
setResult({
riveFile: null,
isLoading: false,
error: 'No Rive file input provided.',
});
return;
}
if (typeof currentInput === 'string') {
if (
currentInput.startsWith('http://') ||
currentInput.startsWith('https://')
) {
currentFile = await RiveFileFactory.fromURL(
currentInput,
initialReferencedAssets.current
);
} else {
currentFile = await RiveFileFactory.fromResource(
currentInput,
initialReferencedAssets.current
);
}
} else if (typeof currentInput === 'number' || 'uri' in currentInput) {
currentFile = await RiveFileFactory.fromSource(
currentInput,
initialReferencedAssets.current
);
} else if (currentInput instanceof ArrayBuffer) {
currentFile = await RiveFileFactory.fromBytes(
currentInput,
initialReferencedAssets.current
);
}
setResult({ riveFile: currentFile!, isLoading: false, error: null });
} catch (err) {
console.error(err);
setResult({
riveFile: null,
isLoading: false,
error:
err instanceof Error
? err.message || 'Unknown error'
: 'Failed to load Rive file',
});
}
};
loadRiveFile();
return () => {
if (currentFile) {
currentFile.release();
}
};
}, [input]);
const { riveFile } = result;
useEffect(() => {
if (initialReferencedAssets.current !== referencedAssets) {
if (riveFile && referencedAssets) {
riveFile.updateReferencedAssets({ data: referencedAssets });
initialReferencedAssets.current = referencedAssets;
}
}
}, [referencedAssets, riveFile]);
if (initialInput.current !== input) {
console.warn(
'useRiveFile: Changing input after initial render is not supported.'
);
}
return {
riveFile: result.riveFile,
isLoading: result.isLoading,
error: result.error,
} as RiveFileHookResult;
}