@zappar/zappar - npm Package Compare versions

Comparing version 0.3.5 to 0.3.7

CHANGELOG.md

 # Changelog
 
+## [Unreleased]
 
+
+## [0.3.7] - 2020-02-03
+
+### Added
+ - Table of contents to `README.md`
+
+### Fixed
+ - README now states that the GL active texture state is changed during some GL-specific calls
+ - Fixed issues on Chrome for iOS
+
+### Changed
+ - Dependencies update
+ - Updated README to reference support for iOS WKWebView from iOS 14.3 and later
+
 ## [0.3.5] - 2020-11-26
@@ -5,0 +20,0 @@

lib/version.d.ts

@@ -1,1 +0,1 @@
-export declare const VERSION = "0.3.5";
+export declare const VERSION = "0.3.7";

lib/version.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VERSION = "0.3.5";
+exports.VERSION = "0.3.7";

package.json

 {
   "name": "@zappar/zappar",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "description": "Zappar's computer vision for JavaScript, supporting image, face and instant world tracking, and barcode scanning.",
@@ -31,4 +31,4 @@ "main": "lib/index.js",
   "dependencies": {
-    "@zappar/zappar-cv": "^0.3.5"
+    "@zappar/zappar-cv": "^0.3.7"
   }
 }

README.md

@@ -11,2 +11,57 @@ # Zappar for JavaScript/TypeScript
 
+## Table Of Contents
+<details>
+<summary>Click to expand table of contents</summary>
+
+<!--ts-->
+   * [Zappar for JavaScript/TypeScript](#zappar-for-javascripttypescript)
+      * [Table Of Contents](#table-of-contents)
+      * [Getting Started](#getting-started)
+         * [Standalone Download](#standalone-download)
+         * [CDN](#cdn)
+         * [NPM Webpack Module](#npm-webpack-module)
+         * [Terminology](#terminology)
+         * [Quick Start](#quick-start)
+         * [Local Preview and Testing](#local-preview-and-testing)
+      * [Compatibility and Browser Support](#compatibility-and-browser-support)
+         * [Detecting Browser Compatibility](#detecting-browser-compatibility)
+      * [Hosting and Publishing Content](#hosting-and-publishing-content)
+         * [Licensing](#licensing)
+         * [ZapWorks Hosting](#zapworks-hosting)
+         * [Self-hosting](#self-hosting)
+      * [Pipelines and Camera Processing](#pipelines-and-camera-processing)
+         * [Creating a Pipeline](#creating-a-pipeline)
+         * [Creating a Frame Source](#creating-a-frame-source)
+         * [Permissions](#permissions)
+         * [Starting the Frame Source](#starting-the-frame-source)
+         * [Handling Window Events](#handling-window-events)
+         * [Processing Frames](#processing-frames)
+         * [Drawing the Camera](#drawing-the-camera)
+            * [Drawing the camera with cameraFrameDrawGL](#drawing-the-camera-with-cameraframedrawgl)
+            * [Manually drawing the camera](#manually-drawing-the-camera)
+      * [Coordinate Systems and Poses](#coordinate-systems-and-poses)
+         * [Projection Matrix](#projection-matrix)
+         * [Camera Pose](#camera-pose)
+         * [Anchor Pose](#anchor-pose)
+      * [Tracking](#tracking)
+         * [Image Tracking](#image-tracking)
+            * [Target File](#target-file)
+            * [Image Anchors](#image-anchors)
+            * [Events](#events)
+         * [Face Tracking](#face-tracking)
+            * [Model File](#model-file)
+            * [Face Anchors](#face-anchors)
+            * [Events](#events-1)
+         * [Face Landmarks](#face-landmarks)
+         * [Face Mesh](#face-mesh)
+         * [Instant World Tracking](#instant-world-tracking)
+      * [Mirroring the Camera](#mirroring-the-camera)
+         * [Mirroring the Canvas](#mirroring-the-canvas)
+         * [Mirroring the camera images and flipping the X-axis of poses](#mirroring-the-camera-images-and-flipping-the-x-axis-of-poses)
+
+<!-- Added by: deim, at: Thu  3 Dec 2020 12:38:04 GMT -->
+
+<!--te-->
+</details>
+
 ## Getting Started
@@ -16,6 +71,6 @@
 
-#### Standalone Download
+### Standalone Download
 
 Download the bundle from this link:
-https://libs.zappar.com/zappar-js/0.3.5/zappar-js.zip
+https://libs.zappar.com/zappar-js/0.3.7/zappar-js.zip
 
@@ -27,10 +82,10 @@ Unzip into your web project and reference from your HTML like this:
 
-#### CDN
+### CDN
 
 Reference the zappar.js library from your HTML like this:
 ```html
-<script src="https://libs.zappar.com/zappar-js/0.3.5/zappar.js"></script>
+<script src="https://libs.zappar.com/zappar-js/0.3.7/zappar.js"></script>
 ```
 
-#### NPM Webpack Module
+### NPM Webpack Module
 
@@ -165,3 +220,5 @@ Run the following NPM command inside your project directory:
  - Most Webkit/Blink-based web browsers for Android, including Brave (good)
+ - Most third-party web browsers for iOS from iOS 14.3 and later (good)
  - iOS in-app web views implemented with SFSafariViewController (good)
+ - iOS in-app web views implemented with WKWebView from iOS 14.3 (good)
  - Firefox for Android (good, however performance may be lower than other browsers)
@@ -173,4 +230,5 @@ - Chrome for Mac/Windows (*)
 *Known to not work:*
- - iOS in-app web views implemented with WKWebView or UIWebView - these iOS technologies do not support camera access at all and thus we're unable to support them. We hope that Apple will rectify this issue in a future iOS release.
- - Non-Safari web browsers on iOS, including Chrome, Firefox and Brave - these browsers use WKWebView due to App Store restrictions and thus do not support camera access.
+ - iOS in-app web views implemented with WKWebView prior to iOS 14.3 - this iOS technology do not support camera access at all and thus we’re unable to support it. Apple has rectified this issue in iOS 14.3.
+ - iOS in-app web views implemented with the deprecated UIWebView component - this iOS technology do not support camera access at all and thus we’re unable to support it.
+ - Non-Safari web browsers on iOS, including Chrome, Firefox and Brave, before iOS 14.3 - these browsers use WKWebView due to App Store restrictions and thus do not support camera access.
 
@@ -347,2 +405,3 @@ \* Browsers without motion sensor access (e.g desktop browsers) don't support instant world tracking or attitude-based camera poses.
  - The currently bound program is set to `null` (e.g. `gl.useProgram(null)`)
+ - The currently active texture is set to `gl.TEXTURE0` (e.g. `gl.activeTexture(gl.TEXTURE0)`)
  - These features are disabled: `gl.SCISSOR_TEST`, `gl.DEPTH_TEST`, `gl.BLEND`, `gl.CULL_FACE`
@@ -380,2 +439,3 @@ - The pixel store flip-Y mode is disabled (e.g. `gl.pixelStorei(gl.UNPACK_FLIP_Y_WEBGL, false)`)
  - The currently bound program is set to `null` (e.g. `gl.useProgram(null)`)
+ - The currently active texture is set to `gl.TEXTURE0` (e.g. `gl.activeTexture(gl.TEXTURE0)`)
  - These features are disabled: `gl.SCISSOR_TEST`, `gl.DEPTH_TEST`, `gl.BLEND`, `gl.CULL_FACE`
@@ -382,0 +442,0 @@

No alert changes

Improved metrics

Total package byte prevSize

6334571

increased by0.06%

Number of lines in readme file

937

increased by6.84%

Dependency changes

• Updated@zappar/zappar-cv@^0.3.7