refactor(encoders): remove archive format, standardize zip (#314)

* refactor(encoders): remove archive format, standardize zip

* Add doc to TOC

---------

Co-authored-by: charlieforward9 <[email protected]>

Author: chrisgervang

docs/api-reference/encoder/README.md

@@ -13,8 +13,8 @@ Encoders are used to capture image frames of an HTML `<canvas/>` and encode them
 | [`WebMEncoder`](/docs/api-reference/encoder/webm-encoder) | Video     | Encodes `.webm` video using [Whammy](https://antimatter15.com/2012/08/whammy-a-real-time-javascript-webm-encoder/). |
 | [`GIFEncoder`](/docs/api-reference/encoder/gif-encoder) | Animated Image | Encodes `.gif` images using `gifshot.js`. | 
 | [`StreamEncoder`](/docs/api-reference/encoder/stream-encoder) | Video     | Encodes `.webm` rough previews, but drops frames. |
-| [`PNGSequenceEncoder`](/docs/api-reference/encoder/png-sequence-encoder) | Image Sequence | Encodes video frames as loseless `.png` contained in a `.tar`. |
-| [`JPEGSequenceEncoder`](/docs/api-reference/encoder/jpeg-sequence-encoder) | Image Sequence | Encodes video frames as compressed `.jpeg` contained in a `.tar`. |
+| [`PNGSequenceEncoder`](/docs/api-reference/encoder/png-sequence-encoder) | Image Sequence | Encodes video frames as loseless `.png` contained in a `.zip`. |
+| [`JPEGSequenceEncoder`](/docs/api-reference/encoder/jpeg-sequence-encoder) | Image Sequence | Encodes video frames as compressed `.jpeg` contained in a `.zip`. |
 
 ### Attributions
 

docs/api-reference/encoder/jpeg-sequence-encoder.md

@@ -1,6 +1,6 @@
 # JPEGSequenceEncoder
 
-A photo sequence encoder that inherits [FrameEncoder](/docs/api-reference/encoder/frame-encoder). Saves each frame as a photo contained in a `".tar"` archive.
+A photo sequence encoder that inherits [FrameEncoder](/docs/api-reference/encoder/frame-encoder). Saves each frame as a photo contained in a `".zip"` archive.
 
 ## Constructor
 
@@ -12,7 +12,7 @@ In addition to the [FrameEncoder](/docs/api-reference/encoder/frame-encoder) set
 
 * `quality` - See member note. Defaults to 1.0.
 
-* `archive` - `zip` or `tar`. Defaults to `tar`.
+* `archive` - `zip`.
 
 ## Members
 

docs/api-reference/encoder/png-sequence-encoder.md

@@ -1,6 +1,6 @@
 # PNGSequenceEncoder
 
-A photo sequence encoder that inherits [FrameEncoder](/docs/api-reference/encoder/frame-encoder). Saves each frame as a photo contained in a `".tar"` archive.
+A photo sequence encoder that inherits [FrameEncoder](/docs/api-reference/encoder/frame-encoder). Saves each frame as a photo contained in a `".zip"` archive.
 
 ## Constructor
 
@@ -10,7 +10,7 @@ Construction of the encoder class is not required. Refer to [DeckAdapter.render]
 
 In addition to the [FrameEncoder](/docs/api-reference/encoder/frame-encoder) settings, these settings are available under the `png` namespace.
 
-* `archive` - `zip` or `tar`. Defaults to `tar`.
+* `archive` - `zip`.
 
 **Notes:**
 

docs/table-of-contents.json

@@ -30,7 +30,8 @@
         "type": "category",
         "label": "Animations",
         "items": [
-          "api-reference/animations/animation-manager"
+          "api-reference/animations/animation-manager",
+          "api-reference/animations/deck-animation"
         ]
       },
       {

examples/website/basic-basemap-mapbox-legacy/app.jsx

@@ -52,11 +52,8 @@ const formatConfigs = {
   webm: {
     quality: 0.8
   },
-  png: {
-    archive: 'zip'
-  },
+  png: {},
   jpeg: {
-    archive: 'zip',
     quality: 0.8
   },
   gif: {
@@ -73,17 +70,16 @@ const timecode = {
 };
 
 const DeckGLOverlay = forwardRef((props, ref) => {
-    // MapboxOverlay handles a variety of props differently than the Deck class.
-    // https://deck.gl/docs/api-reference/mapbox/mapbox-overlay#constructor
-    const deck = useControl(() => new MapboxOverlay({...props, interleaved: true}));
+  // MapboxOverlay handles a variety of props differently than the Deck class.
+  // https://deck.gl/docs/api-reference/mapbox/mapbox-overlay#constructor
+  const deck = useControl(() => new MapboxOverlay({...props, interleaved: true}));
 
-    deck.setProps(props);
+  deck.setProps(props);
 
-    // @ts-expect-error private property
-    setRef(ref, deck._deck);
-    return null;
-  }
-);
+  // @ts-expect-error private property
+  setRef(ref, deck._deck);
+  return null;
+});
 
 const Container = ({children}) => (
   <div
@@ -169,10 +165,7 @@ export default function App({mapStyle = 'mapbox://styles/mapbox/streets-v11'}) {
           onMove={onViewStateChange}
           // Note: 'reuseMap' prop with gatsby and mapbox extension causes stale reference error.
         >
-          <DeckGLOverlay 
-            ref={deckRef} 
-            {...deckProps} 
-          />
+          <DeckGLOverlay ref={deckRef} {...deckProps} />
         </Map>
       </div>
       <BasicControls

examples/website/basic-basemap-mapbox/app.jsx

@@ -52,11 +52,8 @@ const formatConfigs = {
   webm: {
     quality: 0.8
   },
-  png: {
-    archive: 'zip'
-  },
+  png: {},
   jpeg: {
-    archive: 'zip',
     quality: 0.8
   },
   gif: {
@@ -82,8 +79,7 @@ const DeckGLOverlay = forwardRef((props, ref) => {
   // @ts-expect-error private property
   setRef(ref, deck._deck);
   return null;
-}
-);
+});
 
 const Container = ({children}) => (
   <div
@@ -169,10 +165,7 @@ export default function App({mapStyle = 'mapbox://styles/mapbox/streets-v11'}) {
           onMove={onViewStateChange}
           // Note: 'reuseMap' prop with gatsby and mapbox extension causes stale reference error.
         >
-          <DeckGLOverlay 
-            ref={deckRef} 
-            {...deckProps} 
-          />
+          <DeckGLOverlay ref={deckRef} {...deckProps} />
         </Map>
       </div>
       <BasicControls

examples/website/basic-basemap/app.jsx

@@ -53,11 +53,8 @@ const formatConfigs = {
   webm: {
     quality: 0.8
   },
-  png: {
-    archive: 'zip'
-  },
+  png: {},
   jpeg: {
-    archive: 'zip',
     quality: 0.8
   },
   gif: {
@@ -108,7 +105,9 @@ const randomColor = () => [
   Math.floor(Math.random() * 255)
 ];
 
-export default function App({mapStyle = 'https://basemaps.cartocdn.com/gl/positron-gl-style/style.json'}) {
+export default function App({
+  mapStyle = 'https://basemaps.cartocdn.com/gl/positron-gl-style/style.json'
+}) {
   const deckRef = useRef(null);
   const mapRef = useRef(null);
   const [busy, setBusy] = useState(false);
@@ -170,10 +169,7 @@ export default function App({mapStyle = 'https://basemaps.cartocdn.com/gl/positr
           mapLib={maplibregl}
           // Note: 'reuseMap' prop with gatsby and mapbox extension causes stale reference error.
         >
-          <DeckGLOverlay 
-            ref={deckRef} 
-            {...deckProps} 
-          />
+          <DeckGLOverlay ref={deckRef} {...deckProps} />
         </Map>
       </div>
       <BasicControls

examples/website/camera/app.jsx

@@ -27,12 +27,9 @@ const formatConfigs = {
   webm: {
     quality: 0.8
   },
-  png: {
-    archive: 'zip'
-  },
+  png: {},
   jpeg: {
-    quality: 0.8,
-    archive: 'zip'
+    quality: 0.8
   },
   gif: {
     sampleInterval: 1000,

examples/website/terrain/app.jsx

@@ -101,11 +101,8 @@ const formatConfigs = {
   webm: {
     quality: 0.8
   },
-  png: {
-    archive: 'zip'
-  },
+  png: {},
   jpeg: {
-    archive: 'zip',
     quality: 0.8
   },
   gif: {

examples/website/trips/app.tsx

@@ -78,11 +78,8 @@ const formatConfigs = {
   webm: {
     quality: 0.8
   },
-  png: {
-    archive: 'zip'
-  },
+  png: {},
   jpeg: {
-    archive: 'zip',
     quality: 0.8
   },
   gif: {