@pixelverse/strichjs-sdk 1.10.0 → 1.11.0

package/dist/strich.d.ts

@@ -567,15 +567,55 @@ export declare interface OverlayConfiguration {
      */
     maskColor?: string;
     /**
-     * Override the STRICH logo displayed in the bottom-right corner with a custom image.
+     * Indicate if the zoom control should be shown in the overlay.
+     *
+     * @remarks
+     * This is only supported for browsers that support the 'zoom' constraint, see:
+     * https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints#zoom
+     * Notably, Safari versions earlier than 17.4 and Firefox do not support this feature.
      *
-     * The image is supplied as an absolute URL or inline as a data URL. The image should have a transparent background
-     * (WebP or PNG format). The recommended size is 140x30 pixels.
+     * @defaultValue true
+     */
+    showZoom?: boolean;
+    /**
+     * Indicate if double-tapping the overlay should cause the camera to zoom in.
      *
-     * @remarks This is a capability that is only available as a paid add-on for Enterprise licenses. Please note that
+     * @remarks
+     * This is only supported for browsers that support the 'zoom' constraint, see:
+     * https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints#zoom
+     * Notably, Safari versions earlier than 17.4 and Firefox do not support this feature.
+     *
+     * @defaultValue true (where supported)
+     */
+    zoomOnDoubleTap?: boolean;
+    /**
+     * Override the STRICH logo displayed in the bottom-right corner with a custom image.
+     *
+     * This capability is only available for Enterprise licenses. Please note that
      * attempting to hide or replace the STRICH logo by other means is a violation of the License Agreement.
+     *
+     * The image should ideally be supplied in SVG format, either inline as a data URL or as an absolute HTTPS URL.
+     *
+     * The image will be rendered at its intrinsic size (pixel size = CSS size), which can lead to blurriness
+     * on high-density screens if the image is not supplied in SVG format.
+     *
+     * Setting the property to `null` will display no logo at all.
+     */
+    customLogoSrc?: string | null;
+    /**
+     * The size (in CSS pixels) used to render the custom logo.
+     *
+     * Example:
+     *
+     * ```ts
+     * configuration.overlay.customLogoSize = { width: 80, height: 20 };
+     * ```
+     *
+     * When providing a custom logo in a raster image format such as PNG, JPEG or WEBP, the image will be
+     * scaled to fit the specified dimensions. In this case, it's recommended to provide a high-resolution (2x or 3x)
+     * raster image.
      */
-    customLogoSrc?: string;
+    customLogoSize?: Size;
 }
 
 /**
@@ -958,7 +998,7 @@ export declare type SymbologySpec = {
      * @remarks
      * More advanced algorithms will be used to read QR Codes from curved or bent surfaces. This option
      * incurs extra processing time and only makes sense if your QR Codes are printed on curved surfaces
-     * such as bottles, barrels and other cylindrical or spherical items.
+     * such as bottles, barrels, and other cylindrical or spherical items.
      *
      * @defaultValue false
      */