webview-bundle 0.0.0-next.65

TBD
Documentation 
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

# webview-bundle

## Webview Bundle Format (.wvb)

<table>
<thead>
<tr>
  <th colspan="5">Header</th>
  <th>Data</th>
  <th>Footer</th>
</tr>
</thead>
<tbody>
<tr>
  <td>MagicNb</td>
  <td>Version</td>
  <td>F. Descriptors Size</td>
  <td>F. Descriptors</td>
  <td>H. Checksum</td>
  <td>Data</td>
  <td>C. Checksum</td>
</tr>
<tr>
  <td>8 bytes</td>
  <td>1 bytes</td>
  <td>4 bytes</td>
  <td>(...)</td>
  <td>4 bytes</td>
  <td>(...)</td>
  <td>4 bytes</td>
</tr>
</tbody>
</table>

### Header

- **Magic Number (8 bytes)**
  - Big endian format. Value : `0xf09f8c90` / `0xf09f8e81`
  - Represents "🌐🎁" as utf8 encoding.
- **Version (1 bytes)**
  - Version field for this webview bundle format.
  - Available versions:
    - version1: `0x01`
- **File Descriptors Size (4 bytes)**
  - 4 bytes unsigned big endian value (`u32`)
  - Indicates the size of the File Descriptors field to be read next.
- **File Descriptors**
  - This field has dynamic bytes size which is determined by the value of the File Descriptors Size field, and value is big endian format.
  - Format of file descriptors should be `HashMap` formatted:
    - Key is a path for this file.
    - Value contains offset and length.
- **Header checksum (4 bytes)**
  - Header checksum verifies that the full header data has been decoded correctly.
  - The checksum is the result of [xxHash-32 algorithm](https://github.com/Cyan4973/xxHash/blob/release/doc/xxhash_spec.md) digesting the original (decoded) data as input.

### Data

- **Data**
  - This field has dynamic bytes size which can be determined each file offset and length from File Descriptors.
  - The content of data is compressed with [lz4 block format](https://github.com/lz4/lz4/blob/dev/doc/lz4_Block_format.md).

### Footer

- **Content Checksum (4 bytes)**
  - Content checksum verifies that the full data content has been decoded correctly.
  - The checksum is the result of [xxHash-32 algorithm](https://github.com/Cyan4973/xxHash/blob/release/doc/xxhash_spec.md) digesting the original (decoded) data as input.